Paywalls: add PaywallData.revision

This will be used to send it along with the upcoming `PaywallEvent`s.
RevenueCat · Sep 7, 2023 · 8f2d279 · 8f2d279
1 parent 8658338
commit 8f2d279
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 8 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/Paywalls/PaywallData.swift b/Sources/Paywalls/PaywallData.swift
@@ -31,6 +31,9 @@ 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
+
     @EnsureNonEmptyCollectionDecodable
     internal private(set) var localization: [String: LocalizedConfiguration]
 
@@ -336,28 +339,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
         )
     }
 
@@ -417,6 +424,7 @@ extension PaywallData: Codable {
         case config
         case localization = "localizedStrings"
         case assetBaseURL = "assetBaseUrl"
+        case revision
     }
 
 }

diff --git a/...napshots__/PaywallDataValidationTests/testUnrecognizedIconsGeneratesDefaultPaywall.1.json b/...napshots__/PaywallDataValidationTests/testUnrecognizedIconsGeneratesDefaultPaywall.1.json
@@ -36,5 +36,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...s__/PaywallDataValidationTests/testUnrecognizedTemplateNameGeneratesDefaultPaywall.1.json b/...s__/PaywallDataValidationTests/testUnrecognizedTemplateNameGeneratesDefaultPaywall.1.json
@@ -36,5 +36,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...shots__/PaywallDataValidationTests/testUnrecognizedVariableGeneratesDefaultPaywall.1.json b/...shots__/PaywallDataValidationTests/testUnrecognizedVariableGeneratesDefaultPaywall.1.json
@@ -36,5 +36,6 @@
       "title" : "{{ app_name }}"
     }
   },
+  "revision" : -1,
   "template_name" : "2"
 }
diff --git a/...ywallDataValidationTests/testUnrecognizedVariableInFeaturesGeneratesDefaultPaywall.1.json b/...ywallDataValidationTests/testUnrecognizedVariableInFeaturesGeneratesDefaultPaywall.1.json
@@ -36,5 +36,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
@@ -36,5 +36,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/Fixtures/PaywallData-missing_current_locale.json b/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-missing_current_locale.json
@@ -24,5 +24,6 @@
             "dark": null
         }
     },
-    "asset_base_url": "https://rc-paywalls.s3.amazonaws.com"
+    "asset_base_url": "https://rc-paywalls.s3.amazonaws.com",
+    "revision": 1
 }
diff --git a/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-missing_localization.json b/Tests/UnitTests/Networking/Responses/Fixtures/PaywallData-missing_localization.json
@@ -15,5 +15,6 @@
             "dark": null
         }
     },
-    "asset_base_url": "https://rc-paywalls.s3.amazonaws.com"
+    "asset_base_url": "https://rc-paywalls.s3.amazonaws.com",
+    "revision": 1
 }
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(