Create separate `SPM` library to enable custom entitlement computation #2440

NachoSoto · 2023-04-25T17:51:20Z

Fixes SDK-3084

Changes:

Added new ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION compile time flag
Hidden configureInCustomEntitlementsModeWithApiKey behind ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION
Added new RevenueCat_CustomEntitlementComputation SPM target and library
Added CircleCI job for swift build --target RevenueCat_CustomEntitlementComputation
Added new SPMCustomEntitlementComputationInstallation using the new configureInCustomEntitlementsComputationMode
Added CircleCI job for SPMCustomEntitlementComputationInstallation
Added FrameworkDisambiguation.swift to avoid using RevenueCat. disambiguation for files that
Changed API testers to only use the new methods if ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION is defined
Updated DangerousSettings to not expose customEntitlementComputation publicly. The only way to use that now with public API is through Purchases.configureInCustomEntitlementsModeWithApiKey
Updated sample app to use new library

NachoSoto · 2023-04-25T17:52:55Z

CustomEntitlementComputation

@@ -0,0 +1 @@
+Sources


This symlink is necessary because SPM requires independent source directories. It's the same workaround we used for ReceiptParser.

NachoSoto · 2023-04-25T17:53:16Z

Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md

@@ -108,7 +108,6 @@ Most features require configuring the SDK before using it.
 - ``Purchases/setOnesignalID(_:)``

 ### Advanced Configuration
- ``Purchases/configureInCustomEntitlementsComputationMode(apiKey:appUserID:)``


This has to go away because the main framework no longer exposes this.

NachoSoto · 2023-04-25T17:57:40Z

Tests/InstallationTests/SPMCustomEntitlementComputationInstallation/InstallationTests.swift

+
+import RevenueCat_CustomEntitlementComputation
+
+class InstallationTests: XCTestCase {


I solved the testability issue by having new installation tests that use the new API through the new SPM 🎉

NachoSoto · 2023-04-25T17:58:30Z

Tests/InstallationTests/SPMCustomEntitlementComputationInstallation/InstallationTests.swift

+    }
+
+    func testCanSwitchUser() throws {
+        Purchases.shared.switchUser(to: "new_user_ID")


This won't compile yet until #2437 is merged.

This works now cc @tonidero

NachoSoto · 2023-04-25T19:47:32Z

.circleci/config.yml

@@ -168,6 +168,24 @@ commands:
          working_directory: << parameters.directory >>
          when: always

+  scan:


Needed this because the other jobs also archive, which we don't ned for the new job.

aboedo · 2023-04-25T19:46:32Z

Package.swift

+        .target(name: "RevenueCat_CustomEntitlementComputation",
+                path: "CustomEntitlementComputation",
+                exclude: ["Info.plist", "LocalReceiptParsing/ReceiptParser-only-files"],
+                swiftSettings: [.define("ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION")]),


Unrelated to this PR and no need to fix it here, but mentioning before I forget again:
I noticed this today when playing around with a solution:
this file is only meant for receiptParser, but it's not in the folder. It is only marked for target membership in ReceiptParser, though, so we have a disconnect there

Hmm yeah we should move that.

aboedo · 2023-04-25T19:47:36Z

Sources/Misc/DangerousSettings.swift

+    /// - Note: this is `internal` only so the only `public` way to enable `customEntitlementComputation`
+    /// is through ``Purchases/configureInCustomEntitlementsComputationMode(apiKey:appUserID:)``.


aboedo · 2023-04-25T19:48:17Z

Sources/Purchasing/Purchases/Purchases.swift

+    #endif
+
    /**


it'd be great to disable everything else (other than this method and switchUser) for this mode

Oooh, you mean the other configure methods, logIn, etc?

Done in #2442

aboedo · 2023-04-25T19:48:33Z

Sources/Support/FrameworkDisambiguation.swift

+ Purpose: this file is needed because several parts of the SDK need to explicitily reference a type or value
+ from the `RevenueCat` target. However, we expose 2 variants of the framework from SPM:
+ `RevenueCat` and `RevenueCat_CustomEntitlementComputation` (see `Package.swift`).
+  Because of that, we can't simply do `RevenueCat.ErrorCode` for example, since the other variant
+  would need `RevenueCat_CustomEntitlementComputation.ErrorCode`.
+
+  To handle that, this exposes those types explicitly so they work regardless of the name of the framework.


:chefskiss: on the explanation

aboedo · 2023-04-25T19:49:48Z

Tests/InstallationTests/SPMCustomEntitlementComputationInstallation/fastlane/README.md

@@ -0,0 +1,267 @@
+fastlane documentation


probably don't need all the fastlane stuff since we can access through the root fastfile right?

This was autogenerated, probably because it inherits stuff through the import: https://github.com/RevenueCat/purchases-ios/blob/53e3f083d635e9365a1f8618f8d63a035e58f0f4/Tests/InstallationTests/SPMCustomEntitlementComputationInstallation/fastlane/Fastfile

NachoSoto · 2023-04-25T20:08:56Z

I'm gonna update the new test app to use the new SPM.

Fixes SDK-3084 - Added new `ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION` compile time flag - Hidden `configureInCustomEntitlementsModeWithApiKey` behind `ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION` - Added new `RevenueCat_CustomEntitlementComputation` SPM target and library - Added CircleCI job for `swift build --target RevenueCat_CustomEntitlementComputation` - Added new `SPMCustomEntitlementComputationInstallation` using the new `configureInCustomEntitlementsComputationMode` - Added CircleCI job for `SPMCustomEntitlementComputationInstallation` - Added `FrameworkDisambiguation.swift` to avoid using `RevenueCat.` disambiguation for files that - Changed API testers to only use the new methods if `ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION` is defined - Updated `DangerousSettings` to not expose `customEntitlementComputation` publicly. The only way to use that now with `public` API is through `Purchases.configureInCustomEntitlementsModeWithApiKey`

NachoSoto · 2023-04-25T20:57:57Z

Holding on this until we figure out if we want to do this with SPM and/or CP.

NachoSoto · 2023-04-25T21:01:15Z

This is ready to be merged if we're good with SPM.

#2440) Fixes SDK-3084 ![screenshot_2023-04-25_at_10 02 44_480](https://user-images.githubusercontent.com/685609/234360670-bd2628a1-0684-490d-a9eb-33846a60f72a.png) - Added new `ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION` compile time flag - Hidden `configureInCustomEntitlementsModeWithApiKey` behind `ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION` - Added new `RevenueCat_CustomEntitlementComputation` SPM target and library - Added CircleCI job for `swift build --target RevenueCat_CustomEntitlementComputation` - Added new `SPMCustomEntitlementComputationInstallation` using the new `configureInCustomEntitlementsComputationMode` - Added CircleCI job for `SPMCustomEntitlementComputationInstallation` - Added `FrameworkDisambiguation.swift` to avoid using `RevenueCat.` disambiguation for files that - Changed API testers to only use the new methods if `ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION` is defined - Updated `DangerousSettings` to not expose `customEntitlementComputation` publicly. The only way to use that now with `public` API is through `Purchases.configureInCustomEntitlementsModeWithApiKey` - Updated sample app to use new library

NachoSoto added the pr:feat A new feature label Apr 25, 2023

NachoSoto requested a review from a team April 25, 2023 17:51

NachoSoto commented Apr 25, 2023

View reviewed changes

NachoSoto force-pushed the spm-custom-entitlements branch from 7e2bd6c to ae1f190 Compare April 25, 2023 17:54

NachoSoto commented Apr 25, 2023

View reviewed changes

NachoSoto force-pushed the spm-custom-entitlements branch from ae1f190 to 8c844e0 Compare April 25, 2023 17:59

NachoSoto mentioned this pull request Apr 25, 2023

customEntitlementsComputation: new method to switch users #2437

Merged

NachoSoto force-pushed the spm-custom-entitlements branch 4 times, most recently from 587c971 to 53e3f08 Compare April 25, 2023 19:45

NachoSoto commented Apr 25, 2023

View reviewed changes

aboedo approved these changes Apr 25, 2023

View reviewed changes

NachoSoto force-pushed the spm-custom-entitlements branch from 53e3f08 to 67beed5 Compare April 25, 2023 20:12

Base automatically changed from andy/sdk-3068-dangeroussetting-that-disables_rebased to main April 25, 2023 20:21

NachoSoto added 5 commits April 25, 2023 13:22

Fixed job

409b56a

Only scan

b6f6912

Disable other methods

5701f8e

Updated sample app

da51d52

NachoSoto force-pushed the spm-custom-entitlements branch from c96ddc6 to da51d52 Compare April 25, 2023 20:22

Fix build

9c406cd

NachoSoto force-pushed the spm-custom-entitlements branch from 63c9a6c to 9c406cd Compare April 25, 2023 20:56

NachoSoto enabled auto-merge (squash) April 25, 2023 22:07

NachoSoto merged commit 64c8638 into main Apr 25, 2023

NachoSoto deleted the spm-custom-entitlements branch April 25, 2023 22:12

NachoSoto mentioned this pull request Apr 26, 2023

[DO NOT MERGE] Release/4.18.0 #2445

Closed

RCGitBot mentioned this pull request May 3, 2023

[AUTOMATIC] Release/4.19.0 #2466

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create separate `SPM` library to enable custom entitlement computation #2440

Create separate `SPM` library to enable custom entitlement computation #2440

NachoSoto commented Apr 25, 2023 •

edited

Loading

NachoSoto Apr 25, 2023

NachoSoto Apr 25, 2023

NachoSoto Apr 25, 2023

NachoSoto Apr 25, 2023

NachoSoto Apr 25, 2023

NachoSoto Apr 25, 2023

aboedo Apr 25, 2023

NachoSoto Apr 25, 2023

aboedo Apr 25, 2023

aboedo Apr 25, 2023

NachoSoto Apr 25, 2023

NachoSoto Apr 25, 2023

aboedo Apr 25, 2023

aboedo Apr 25, 2023

NachoSoto Apr 25, 2023

NachoSoto commented Apr 25, 2023

NachoSoto commented Apr 25, 2023

NachoSoto commented Apr 25, 2023


		import RevenueCat_CustomEntitlementComputation

		class InstallationTests: XCTestCase {

		/// - Note: this is `internal` only so the only `public` way to enable `customEntitlementComputation`
		/// is through ``Purchases/configureInCustomEntitlementsComputationMode(apiKey:appUserID:)``.

		@@ -0,0 +1 @@
		Sources

Create separate SPM library to enable custom entitlement computation #2440

Create separate SPM library to enable custom entitlement computation #2440

Conversation

NachoSoto commented Apr 25, 2023 • edited Loading

Changes:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NachoSoto commented Apr 25, 2023

NachoSoto commented Apr 25, 2023

NachoSoto commented Apr 25, 2023

Create separate `SPM` library to enable custom entitlement computation #2440

Create separate `SPM` library to enable custom entitlement computation #2440

NachoSoto commented Apr 25, 2023 •

edited

Loading