[SK2] Add `Configuration.with(storeKitVersion:)` to select the version of StoreKit to use by MarkVillacampa · Pull Request #3487 · RevenueCat/purchases-ios

MarkVillacampa · 2023-12-04T18:58:56Z

This PR introduces a new configuration option to select the StoreKit version to use.

It supersedes the deprecated .with(usesStoreKit2IfAvailable: true) and the internal usesStoreKit2JWS configuration options.

Uses JWS tokens instead of SK1 receipts when in StoreKit 2 mode where applicable.

Example usage:

Purchases.configure(
            with: .builder(withAPIKey: apiKey)
                .with(storeKitVersion: .storeKit2)
                .build()

NachoSoto · 2023-12-06T17:18:44Z

+}
+
+extension StoreKitVersion {
+    var versionString: String {


Nit: spacing here

NachoSoto · 2023-12-06T17:19:19Z

+
+extension StoreKitVersion {
+    var versionString: String {
+        if isStoreKit2EnabledAndAvailable {


Explicit self:

Suggested change

if isStoreKit2EnabledAndAvailable {

if self.isStoreKit2EnabledAndAvailable {

NachoSoto · 2023-12-06T17:20:01Z

+
+@testable import RevenueCat
+
+class StoreKitVersionTests: TestCase {


NachoSoto · 2023-12-06T17:20:52Z

    "X-Platform-Flavor" : "native",
    "X-Platform-Version" : "Version 17.0.0 (Build 21A342)",
    "X-Storefront" : "USA",
+    "X-StoreKit-Version" : "1",


This is a better header than X-StoreKit2-Enabled 👍🏻

NachoSoto · 2023-12-06T17:21:19Z

+        ///
+        /// ### Related Symbols
+        /// - ``StoreKitVersion``
+        @objc public func with(storeKitVersion version: StoreKitVersion) -> Builder {


I started doing this for #3066 but ended up removing it. I think it's a better API 👍🏻

NachoSoto · 2023-12-06T17:23:28Z

Looks good in general, but I want to discuss the duplicate flag.

NachoSoto · 2023-12-06T18:04:02Z

Let's print the configured SK version on SDK initialization too: https://github.com/RevenueCat/purchases-ios/blob/main/Sources/Purchasing/Purchases/Purchases.swift#L556

…reKit to use

codecov · 2023-12-18T15:26:36Z

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (32c63cd) 85.97% compared to head (0e854bb) 85.97%.
Report is 13 commits behind head on sk2-full-flow.

Files	Patch %	Lines
Sources/Misc/StoreKitVersion.swift	83.87%	5 Missing ⚠️
Sources/Purchasing/Purchases/Purchases.swift	71.42%	2 Missing ⚠️
Sources/Logging/Strings/ConfigureStrings.swift	66.66%	1 Missing ⚠️
Sources/Support/DebugUI/DebugViewModel.swift	0.00%	1 Missing ⚠️

Additional details and impacted files

@@                Coverage Diff                @@
##           sk2-full-flow    #3487      +/-   ##
=================================================
- Coverage          85.97%   85.97%   -0.01%     
=================================================
  Files                240      240              
  Lines              17494    17490       -4     
=================================================
- Hits               15041    15037       -4     
  Misses              2453     2453

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

NachoSoto · 2023-12-18T19:06:31Z


    case response_verification_mode(Signing.ResponseVerificationMode)

+    case storekit_version(String)


This String could be anything. Better to use StoreKitVersion to make it type safe.

NachoSoto · 2023-12-18T19:08:21Z

+    case storeKit2
+
+    /// Let RevenueCat use the most appropiate version of StoreKit
+    case `default`


Instead of making this a case, I think it would make more sense to define it like this:

extension StoreKitVersion { public static `default`: Self = .storeKit1 }

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.

NachoSoto · 2023-12-18T19:10:07Z

+
+extension StoreKitVersion {
+
+    var versionString: String {


Nit: putting the type of the value in the name isn't a thing anymore 😅

Maybe we can do this:

extension StoreKitVersion: CustomDebugStringConvertible { public var debugDescription: { switch self {} // Let's use a switch, so if we ever add more cases, the compiler reminds us to handle it here. } }

Objc throwback 🤣

Renamed it to effectiveVersion instead of using the debugDescription mechanism since it does not represent the enum value, but the effective version of StoreKit that's use despite what's configured. Added a docstring comment too.

NachoSoto

Let's agree one what to do with StoreKit2Setting

MarkVillacampa · 2023-12-19T16:31:12Z

        expect(self.receiptFetcher.receiptDataReceivedRefreshPolicy) == .onlyIfEmpty
    }

+    func testPurchaseSK1PackageRetriesReceiptFetchIfEnabled() async throws {


Functionally equivalent to the removed test below, but uses SK1, since SK2 does not post receipts now.

NachoSoto · 2023-12-19T16:58:22Z

+public extension StoreKitVersion {
+
+    /// Let RevenueCat use the most appropiate version of StoreKit
+    static var `default` = Self.storeKit1


Oops! This is mutable , meaning you can do

StoreKitVersion.default = .storeKit2 😬

Suggested change

static var `default` = Self.storeKit1

static let `default`: Self = .storeKit1

omg good catch 😅

NachoSoto · 2023-12-19T17:01:28Z

+
+    /// Returns a string representing the effective version of StoreKit used.
+    /// This can be different from the configured version if StoreKit 2 is not available on the current device.
+    var effectiveVersion: String {


It seems like this is doing 2 things:

Detecting the effective StoreKitVersion

Converting to String

I'd change this to

Suggested change

var effectiveVersion: String {

var effectiveVersion: StoreKitVersion {

Then maybe using my CustomDebugStringConvertible suggestion?

NachoSoto · 2023-12-19T17:04:07Z

-
-    Simply remove this method call to let RevenueCat decide for you which StoreKit implementation to use.
-    """)
+    @available(*, deprecated, message: "Use .with(storeKitVersion:) to enable StoreKit 2")


NachoSoto · 2023-12-19T17:06:45Z


        Logger.debug(Strings.configure.debug_enabled, fileName: nil)
-        if systemInfo.storeKit2Setting == .enabledForCompatibleDevices {
+        if systemInfo.storeKitVersion.isStoreKit2EnabledAndAvailable {


Maybe we can remove this now that we have the generic storekit_version below?

NachoSoto · 2023-12-19T17:08:15Z

@@ -0,0 +1,50 @@
+{


Oops, can you remove this file?

…n of StoreKit to use (#3487) This PR introduces a new configuration option to select the StoreKit version to use. It supersedes the deprecated `.with(usesStoreKit2IfAvailable: true)` and the internal `usesStoreKit2JWS` configuration options. Uses JWS tokens instead of SK1 receipts when in StoreKit 2 mode where applicable. Example usage: ```swift Purchases.configure( with: .builder(withAPIKey: apiKey) .with(storeKitVersion: .storeKit2) .build() ```

MarkVillacampa added the pr:feat A new feature label Dec 4, 2023

NachoSoto reviewed Dec 6, 2023

View reviewed changes

MarkVillacampa force-pushed the sk2-version-configuration branch from c47b5bd to f2a0820 Compare December 13, 2023 12:28

Base automatically changed from sk2-receipt to main December 13, 2023 16:00

Add Configuration.with(storeKitVersion:) to select the version of Sto…

4886d77

…reKit to use

MarkVillacampa force-pushed the sk2-version-configuration branch from 85b2048 to 4886d77 Compare December 13, 2023 16:19

MarkVillacampa added 4 commits December 18, 2023 14:35

fix tests

cb88d35

fix tests

a98060c

fix tests

49a3517

fix tests

e06da0c

NachoSoto added the feat:StoreKit 2 label Dec 18, 2023

NachoSoto reviewed Dec 18, 2023

View reviewed changes

Comment thread Sources/Misc/SystemInfo.swift

NachoSoto suggested changes Dec 18, 2023

View reviewed changes

MarkVillacampa added 2 commits December 19, 2023 17:23

Remove StoreKit2Setting

bfac38d

Use stronger type

252093f

MarkVillacampa commented Dec 19, 2023

View reviewed changes

MarkVillacampa added 2 commits December 19, 2023 17:54

rename debugDescription to effectiveVersion

89a68b9

use isStoreKit2EnabledAndAvailable

9e1ab81

NachoSoto reviewed Dec 19, 2023

View reviewed changes

make default immutable

b5a2efb

NachoSoto reviewed Dec 19, 2023

View reviewed changes

MarkVillacampa added 2 commits December 20, 2023 11:32

fixes

4f72f4d

fix

0e854bb

MarkVillacampa changed the base branch from main to sk2-full-flow December 20, 2023 10:50

MarkVillacampa merged commit f1a70e4 into sk2-full-flow Dec 20, 2023

MarkVillacampa deleted the sk2-version-configuration branch December 20, 2023 10:53

MarkVillacampa mentioned this pull request Dec 20, 2023

[WIP] Add support for StoreKit 2 full flow #3529

Closed

7 tasks

facumenzella mentioned this pull request May 29, 2026

feat(workflows): wire workflow step lifecycle events in PaywallViewModel #6868

Merged

	if isStoreKit2EnabledAndAvailable {
	if self.isStoreKit2EnabledAndAvailable {


		@testable import RevenueCat

		class StoreKitVersionTests: TestCase {


		case response_verification_mode(Signing.ResponseVerificationMode)

		case storekit_version(String)

	static var `default` = Self.storeKit1
	static let `default`: Self = .storeKit1

	var effectiveVersion: String {
	var effectiveVersion: StoreKitVersion {

Uh oh!

Conversation

MarkVillacampa commented Dec 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NachoSoto commented Dec 6, 2023

Uh oh!

NachoSoto commented Dec 6, 2023

Uh oh!

codecov Bot commented Dec 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NachoSoto left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MarkVillacampa commented Dec 4, 2023 •

edited

Loading

codecov Bot commented Dec 18, 2023 •

edited

Loading