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

Add uiPreviewMode to DangerousSettings #4714

Merged
merged 4 commits into from
Jan 28, 2025
Merged

Add uiPreviewMode to DangerousSettings #4714

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
6ec9cd2
add new opt-in public API `uiPreviewMode` to `DangerousSettings`
ajpallares Jan 27, 2025
0cae5a1
fix: add missing `convenience` to `uiPreviewInitializer` of `Dangerou…
ajpallares Jan 27, 2025
fffa4b9
docs: change documentation of `DangerousSettings` init
ajpallares Jan 28, 2025
f406e82
test: add API test for new `DangerousSettings` init
ajpallares Jan 28, 2025
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
20 changes: 19 additions & 1 deletion Sources/Misc/DangerousSettings.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ import Foundation
*/
@objc public let autoSyncPurchases: Bool

/**
* if `true`, the SDK will return a set of mock products instead of the
* products obtained from StoreKit. This is useful for testing or preview purposes.
*/
@_spi(Internal) public let uiPreviewMode: Bool

Comment on lines +61 to +66
Copy link
Member

Choose a reason for hiding this comment

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

maybe we can add the API tests to go along with it in this same PR? Those serve to also showcase the usage

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in f406e82

/**
* A property meant for apps that do their own entitlements computation, separated from RevenueCat.
* It:
Expand Down Expand Up @@ -101,13 +107,25 @@ import Foundation

}

/**
* Used to initialize the SDK in UI preview mode.
*
* - Parameter uiPreviewMode: if `true`, the SDK will return a set of mock products instead of the
* products obtained from StoreKit. This is useful for testing or preview purposes.
*/
@_spi(Internal) public convenience init(uiPreviewMode: Bool) {
self.init(autoSyncPurchases: false, internalSettings: Internal.default, uiPreviewMode: uiPreviewMode)
}

/// Designated initializer
internal init(autoSyncPurchases: Bool,
customEntitlementComputation: Bool = false,
internalSettings: InternalDangerousSettingsType) {
internalSettings: InternalDangerousSettingsType,
uiPreviewMode: Bool = false) {
self.autoSyncPurchases = autoSyncPurchases
self.internalSettings = internalSettings
self.customEntitlementComputation = customEntitlementComputation
self.uiPreviewMode = uiPreviewMode
}

}
Expand Down
6 changes: 6 additions & 0 deletions Tests/APITesters/AllAPITests/AllAPITests.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@
3502630E2CF61E9F00894270 /* SubscriptionInfoAPI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3502630D2CF61E9A00894270 /* SubscriptionInfoAPI.swift */; };
35370AC52CFF8304004F0A64 /* RCSubscriptionInfoAPI.h in Headers */ = {isa = PBXBuildFile; fileRef = 35370AC42CFF82F8004F0A64 /* RCSubscriptionInfoAPI.h */; };
35370AC82CFF8317004F0A64 /* RCSubscriptionInfoAPI.m in Sources */ = {isa = PBXBuildFile; fileRef = 35370AC72CFF8312004F0A64 /* RCSubscriptionInfoAPI.m */; };
75C1B6AD2D48D4550011512D /* DangerousSettingsAPI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 75C1B6AC2D48D4550011512D /* DangerousSettingsAPI.swift */; };
FD33CD732D03587E000D13A4 /* CustomerCenterViewControllerAPI.swift in Sources */ = {isa = PBXBuildFile; fileRef = FD33CD722D035876000D13A4 /* CustomerCenterViewControllerAPI.swift */; };
FDCC983A2D0A0FD500F5854B /* CustomerCenterViewAPI.swift in Sources */ = {isa = PBXBuildFile; fileRef = FDCC98392D0A0FD500F5854B /* CustomerCenterViewAPI.swift */; };
/* End PBXBuildFile section */
Expand Down Expand Up @@ -354,6 +355,8 @@
3502630D2CF61E9A00894270 /* SubscriptionInfoAPI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SubscriptionInfoAPI.swift; sourceTree = "<group>"; };
35370AC42CFF82F8004F0A64 /* RCSubscriptionInfoAPI.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RCSubscriptionInfoAPI.h; sourceTree = "<group>"; };
35370AC72CFF8312004F0A64 /* RCSubscriptionInfoAPI.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RCSubscriptionInfoAPI.m; sourceTree = "<group>"; };
75C1B6AC2D48D4550011512D /* DangerousSettingsAPI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DangerousSettingsAPI.swift; sourceTree = "<group>"; };
75C1B6AE2D48D4DB0011512D /* RevenueCat.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; path = RevenueCat.framework; sourceTree = BUILT_PRODUCTS_DIR; };
FD33CD722D035876000D13A4 /* CustomerCenterViewControllerAPI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomerCenterViewControllerAPI.swift; sourceTree = "<group>"; };
FDCC98392D0A0FD500F5854B /* CustomerCenterViewAPI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomerCenterViewAPI.swift; sourceTree = "<group>"; };
/* End PBXFileReference section */
Expand Down Expand Up @@ -533,6 +536,7 @@
2D4C61942C5AD34900A29FD2 /* Frameworks */ = {
isa = PBXGroup;
children = (
75C1B6AE2D48D4DB0011512D /* RevenueCat.framework */,
2D4C62D82C5D41EC00A29FD2 /* RevenueCat.framework */,
2D4C62D42C5D41E200A29FD2 /* RevenueCat.framework */,
2D4C62D02C5D41D400A29FD2 /* ReceiptParser.framework */,
Expand All @@ -551,6 +555,7 @@
2D4C61D42C5AD62900A29FD2 /* ConfigurationAPI.swift */,
1E37C7812C6518410009D546 /* CustomerCenterConfigDataAPI.swift */,
2D4C61C92C5AD62800A29FD2 /* CustomerInfoAPI.swift */,
75C1B6AC2D48D4550011512D /* DangerousSettingsAPI.swift */,
2D4C61CA2C5AD62900A29FD2 /* EntitlementInfoAPI.swift */,
2D4C61C12C5AD62800A29FD2 /* EntitlementInfosAPI.swift */,
2D4C61D52C5AD62900A29FD2 /* ErrorCodesAPI.swift */,
Expand Down Expand Up @@ -1021,6 +1026,7 @@
2D4C61E32C5AD62A00A29FD2 /* PurchasesDiagnosticsAPI.swift in Sources */,
2D4C61E22C5AD62A00A29FD2 /* CustomerInfoAPI.swift in Sources */,
2D4C61DC2C5AD62A00A29FD2 /* StoreTransactionAPI.swift in Sources */,
75C1B6AD2D48D4550011512D /* DangerousSettingsAPI.swift in Sources */,
2D4C61EC2C5AD62A00A29FD2 /* AttributionAPI.swift in Sources */,
2D4C61EB2C5AD62A00A29FD2 /* AttributionNetworkAPI.swift in Sources */,
2D4C61ED2C5AD62A00A29FD2 /* PackageAPI.swift in Sources */,
Expand Down
18 changes: 18 additions & 0 deletions Tests/APITesters/AllAPITests/SwiftAPITester/DangerousSettingsAPI.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//
// 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
//
// DangerousSettingsAPI.swift
//
// Created by Antonio Pallares on 28/1/25.

@_spi(Internal) import RevenueCat

func checkDangerousSettingsAPI() {
let _: DangerousSettings = DangerousSettings(uiPreviewMode: true)
}
2 changes: 2 additions & 0 deletions Tests/APITesters/AllAPITests/SwiftAPITester/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,7 @@ func main() -> Int {

checkVerificationResultAPI()

checkDangerousSettingsAPI()

return 0
}