Paywalls: add PaywallData.revision (#3155)

This will be used to send it along with the upcoming `PaywallEvent`s.
RevenueCat · Sep 14, 2023 · 46047c1 · 46047c1
1 parent d77aa40
commit 46047c1
Show file tree

Hide file tree

Showing 15 changed files with 43 additions and 10 deletions.
diff --git a/RevenueCatUI/Helpers/PaywallData+Default.swift b/RevenueCatUI/Helpers/PaywallData+Default.swift
@@ -40,13 +40,15 @@ extension PaywallData {
                 displayRestorePurchases: true
             ),
             localization: Self.localization,
-            assetBaseURL: Self.defaultTemplateBaseURL
+            assetBaseURL: Self.defaultTemplateBaseURL,
+            revision: Self.revisionID
         )
     }
 
     static let defaultTemplate: PaywallTemplate = .template2
 
     static let appIconPlaceholder = "revenuecatui_default_paywall_app_icon"
+    static let revisionID: Int = -1
 
 }
 

diff --git a/Sources/Misc/Codable/DefaultDecodable.swift b/Sources/Misc/Codable/DefaultDecodable.swift
@@ -199,6 +199,10 @@ enum DefaultDecodable {
             static var defaultValue: String { "" }
         }
 
+        enum Zero: DefaultValueProvider {
+            static var defaultValue: Int { 0 }
+        }
+
         enum EmptyArray<T: List>: DefaultValueProvider {
             static var defaultValue: T { [] }
         }
@@ -226,6 +230,7 @@ enum DefaultDecodable {
  *   @DefaultDecodable.EmptyArray var values: [String]
  *   @DefaultDecodable.EmptyDictionary var dictionary: [String: Int]
  *   @DefaultDecodable.Now var date: Date
+ *   @DefaultDecodable.Zero var number: Int
  * }
  * ```
  */
@@ -237,5 +242,6 @@ extension DefaultDecodable {
     typealias EmptyArray<T: List> = DefaultValue<Sources.EmptyArray<T>>
     typealias EmptyDictionary<T: Map> = DefaultValue<Sources.EmptyDictionary<T>>
     typealias Now = DefaultValue<Sources.Now>
+    typealias Zero = DefaultValue<Sources.Zero>
 
 }
diff --git a/Sources/Paywalls/PaywallData.swift b/Sources/Paywalls/PaywallData.swift
@@ -11,7 +11,7 @@
 //
 //  Created by Nacho Soto on 7/10/23.
 
-// swiftlint:disable file_length
+// swiftlint:disable file_length identifier_name
 
 import Foundation
 
@@ -31,6 +31,15 @@ public struct PaywallData {
     /// The base remote URL where assets for this paywall are stored.
     public var assetBaseURL: URL
 
+    /// The revision identifier for this paywall.
+    public var revision: Int {
+        get { return self._revision }
+        set { self._revision = newValue }
+    }
+
+    @DefaultDecodable.Zero
+    internal private(set) var _revision: Int = 0
+
     @EnsureNonEmptyCollectionDecodable
     internal private(set) var localization: [String: LocalizedConfiguration]
 
@@ -60,8 +69,6 @@ public protocol PaywallLocalizedConfiguration {
 
 }
 
-// swiftlint:disable identifier_name
-
 extension PaywallData {
 
     /// Defines the necessary localized information for a paywall.
@@ -347,28 +354,32 @@ extension PaywallData {
         templateName: String,
         config: Configuration,
         localization: [String: LocalizedConfiguration],
-        assetBaseURL: URL
+        assetBaseURL: URL,
+        revision: Int = 0
     ) {
         self.templateName = templateName
         self.config = config
         self.localization = localization
         self.assetBaseURL = assetBaseURL
+        self.revision = revision
     }
 
     /// Creates a test ``PaywallData`` with one localization
     public init(
         templateName: String,
         config: Configuration,
         localization: LocalizedConfiguration,
-        assetBaseURL: URL
+        assetBaseURL: URL,
+        revision: Int = 0
     ) {
         let locale = Locale.current.identifier
 
         self.init(
             templateName: templateName,
             config: config,
             localization: [locale: localization],
-            assetBaseURL: assetBaseURL
+            assetBaseURL: assetBaseURL,
+            revision: revision
         )
     }
 
@@ -428,6 +439,7 @@ extension PaywallData: Codable {
         case config
         case localization = "localizedStrings"
         case assetBaseURL = "assetBaseUrl"
+        case _revision = "revision"
     }
 
 }

diff --git a/Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift b/Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift
@@ -18,11 +18,13 @@ func checkPaywallData(_ data: PaywallData) {
     let _: PaywallData.LocalizedConfiguration? = data.config(for: Locale.current)
     let localization: PaywallData.LocalizedConfiguration = data.localizedConfiguration
     let assetBaseURL: URL = data.assetBaseURL
+    let revision: Int = data.revision
 
     let _: PaywallData = .init(templateName: templateName,
                                config: config,
                                localization: localization,
-                               assetBaseURL: assetBaseURL)
+                               assetBaseURL: assetBaseURL,
+                               revision: revision)
 }
 
 func checkPaywallConfiguration(_ config: PaywallData.Configuration,

diff --git a/...kendIntegrationTests/__Snapshots__/LoadShedderIntegrationTests/testCanGetOfferings.1.json b/...kendIntegrationTests/__Snapshots__/LoadShedderIntegrationTests/testCanGetOfferings.1.json
@@ -56,6 +56,7 @@
             "title" : "Ignite your child's curiosity"
           }
         },
+        "revision" : 1,
         "template_name" : "1"
       }
     },

diff --git a/...BackendIntegrationTests/__Snapshots__/StoreKitIntegrationTests/testCanGetOfferings.1.json b/...BackendIntegrationTests/__Snapshots__/StoreKitIntegrationTests/testCanGetOfferings.1.json
@@ -70,6 +70,7 @@
             "title" : "Ignite your child's curiosity"
           }
         },
+        "revision" : 3,
         "template_name" : "2"
       }
     },

diff --git a/...napshots__/PaywallDataValidationTests/testUnrecognizedIconsGeneratesDefaultPaywall.1.json b/...napshots__/PaywallDataValidationTests/testUnrecognizedIconsGeneratesDefaultPaywall.1.json
@@ -38,5 +38,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...s__/PaywallDataValidationTests/testUnrecognizedTemplateNameGeneratesDefaultPaywall.1.json b/...s__/PaywallDataValidationTests/testUnrecognizedTemplateNameGeneratesDefaultPaywall.1.json
@@ -38,5 +38,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...shots__/PaywallDataValidationTests/testUnrecognizedVariableGeneratesDefaultPaywall.1.json b/...shots__/PaywallDataValidationTests/testUnrecognizedVariableGeneratesDefaultPaywall.1.json
@@ -38,5 +38,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...ywallDataValidationTests/testUnrecognizedVariableInFeaturesGeneratesDefaultPaywall.1.json b/...ywallDataValidationTests/testUnrecognizedVariableInFeaturesGeneratesDefaultPaywall.1.json
@@ -38,5 +38,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...atUITests/Data/__Snapshots__/PaywallDataValidationTests/testValidateMissingPaywall.1.json b/...atUITests/Data/__Snapshots__/PaywallDataValidationTests/testValidateMissingPaywall.1.json
@@ -38,5 +38,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/Tests/UnitTests/Networking/Responses/Fixtures/Offerings.json b/Tests/UnitTests/Networking/Responses/Fixtures/Offerings.json
@@ -84,7 +84,8 @@
                         "dark": null
                     }
                 },
-                "asset_base_url": "https://rc-paywalls.s3.amazonaws.com"
+                "asset_base_url": "https://rc-paywalls.s3.amazonaws.com",
+                "revision": 5
             }
         },
         {

diff --git a/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-Sample1.json b/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-Sample1.json
@@ -69,5 +69,6 @@
             }
         }
     },
-    "asset_base_url": "https://rc-paywalls.s3.amazonaws.com"
+    "asset_base_url": "https://rc-paywalls.s3.amazonaws.com",
+    "revision": 7
 }
diff --git a/Tests/UnitTests/Networking/Responses/OfferingsDecodingTests.swift b/Tests/UnitTests/Networking/Responses/OfferingsDecodingTests.swift
@@ -112,6 +112,7 @@ class OfferingsDecodingTests: BaseHTTPResponseTest {
         let paywall = try XCTUnwrap(offering.paywall)
         expect(paywall.templateName) == "1"
         try expect(paywall.assetBaseURL) == XCTUnwrap(URL(string: "https://rc-paywalls.s3.amazonaws.com"))
+        expect(paywall.revision) == 5
 
         expect(paywall.config.packages) == ["$rc_monthly", "$rc_annual", "custom_package"]
         expect(paywall.config.defaultPackage).to(beNil())

diff --git a/Tests/UnitTests/Paywalls/PaywallDataTests.swift b/Tests/UnitTests/Paywalls/PaywallDataTests.swift
@@ -22,6 +22,7 @@ class PaywallDataTests: BaseHTTPResponseTest {
 
         expect(paywall.templateName) == "1"
         expect(paywall.assetBaseURL) == URL(string: "https://rc-paywalls.s3.amazonaws.com")!
+        expect(paywall.revision) == 7
         expect(paywall.config.packages) == ["$rc_monthly", "$rc_annual", "custom_package"]
         expect(paywall.config.defaultPackage) == "$rc_annual"
         expect(paywall.config.images) == .init(