Disable record on regular snapshot tests to prevent from passing after retry

Package.swift

@@ -47,10 +47,9 @@ let shouldIncludeDocCPlugin = environmentVariables["INCLUDE_DOCC_PLUGIN"] == "tr
 
 var dependencies: [Package.Dependency] = [
     .package(url: "https://github.com/quick/nimble", exact: "13.7.1"),
-    // SST requires iOS 13 starting from version 1.13.0
     .package(
         url: "https://github.com/pointfreeco/swift-snapshot-testing",
-        revision: "26ed3a2b4a2df47917ca9b790a57f91285b923fb"
+        exact: "1.18.9"
     )
 ]
 if shouldIncludeDocCPlugin {

Package@swift-5.8.swift

@@ -11,10 +11,11 @@ let shouldIncludeDocCPlugin = environmentVariables["INCLUDE_DOCC_PLUGIN"] == "tr
 
 var dependencies: [Package.Dependency] = [
     .package(url: "https://github.com/quick/nimble", exact: "13.7.1"),
-    // SST requires iOS 13 starting from version 1.13.0
+    // Uses SST 1.17.7, the last version with swift-tools-version 5.7, which includes the
+    // `withSnapshotTesting` API needed to prevent auto-recording in CI.
     .package(
         url: "https://github.com/pointfreeco/swift-snapshot-testing",
-        revision: "26ed3a2b4a2df47917ca9b790a57f91285b923fb"
+        exact: "1.17.7"
     )
 ]
 if shouldIncludeDocCPlugin {

Tests/BackendIntegrationTests/FallbackURLBackendIntegrationTests.swift

@@ -55,15 +55,15 @@ class FallbackURLSignedBackendStoreKit2IntegrationTests: BaseStoreKitIntegration
         let receivedOfferings = try await self.purchases.offerings()
 
         expect(receivedOfferings.all).toNot(beEmpty())
-        assertSnapshot(matching: receivedOfferings.response, as: .formattedJson)
+        assertSnapshot(of: receivedOfferings.response, as: .formattedJson)
         expect(receivedOfferings.contents.originalSource) == .fallbackUrl
     }
 
     func testCanGetProductEntitlementMappingFromFallbackURL() async throws {
         let productEntitlementMapping = try await self.purchases.productEntitlementMapping()
 
         expect(productEntitlementMapping.entitlementsByProduct).toNot(beEmpty())
-        assertSnapshot(matching: productEntitlementMapping, as: .formattedJson)
+        assertSnapshot(of: productEntitlementMapping, as: .formattedJson)
     }
 
 }

Tests/BackendIntegrationTests/LoadShedderIntegrationTests.swift

@@ -98,7 +98,7 @@ class BaseLoadShedderStoreKitIntegrationTests: BaseStoreKitIntegrationTests {
 
         expect(receivedOfferings.all).toNot(beEmpty())
 
-        assertSnapshot(matching: receivedOfferings.response, as: .formattedJson)
+        assertSnapshot(of: receivedOfferings.response, as: .formattedJson)
 
         self.logger.verifyMessageWasLogged(
             Strings.network.request_handled_by_load_shedder(

Tests/BackendIntegrationTests/StoreKitIntegrationTests.swift

@@ -174,7 +174,7 @@ class StoreKit1IntegrationTests: BaseStoreKitIntegrationTests {
         let receivedOfferings = try await self.purchases.offerings()
 
         expect(receivedOfferings.all).toNot(beEmpty())
-        assertSnapshot(matching: receivedOfferings.response, as: .formattedJson)
+        assertSnapshot(of: receivedOfferings.response, as: .formattedJson)
 
         self.logger.verifyMessageWasLogged(Strings.offering.vending_offerings_cache_from_memory,
                                            level: .debug)

Tests/RevenueCatUITests/Data/PaywallDataValidationTests.swift

@@ -293,7 +293,7 @@ private extension PaywallDataValidationTests {
         #endif
 
         assertSnapshot(
-            matching: paywall.withTestAssetBaseURL,
+            of: paywall.withTestAssetBaseURL,
             as: .formattedJson,
             file: file,
             testName: test,

Tests/RevenueCatUITests/Helpers/TestCase.swift

@@ -33,8 +33,6 @@ class TestCase: XCTestCase {
     @MainActor
     override class func setUp() {
         XCTestObservationCenter.shared.addTestObserver(CurrentTestCaseTracker.shared)
-
-        SnapshotTests.updateSnapshotsIfNeeded()
     }
 
     @MainActor
@@ -49,6 +47,18 @@ class TestCase: XCTestCase {
         self.initializeLogger()
     }
 
+    override func invokeTest() {
+        if SnapshotTests.shouldRecordSnapshots {
+            withSnapshotTesting(record: .all) {
+                super.invokeTest()
+            }
+        } else {
+            withSnapshotTesting(record: .never) {
+                super.invokeTest()
+            }
+        }
+    }
+
     @MainActor
     override func tearDown() {
         self.logger = nil
@@ -61,15 +71,8 @@ class TestCase: XCTestCase {
 }
 
 private enum SnapshotTests {
-
-    private static var environmentVariableChecked = false
-
-    static func updateSnapshotsIfNeeded() {
-        guard !Self.environmentVariableChecked else { return }
-
-        if ProcessInfo.processInfo.environment["CIRCLECI_TESTS_GENERATE_REVENUECAT_UI_SNAPSHOTS"] == "1" {
-            isRecording = true
-        }
+    static var shouldRecordSnapshots: Bool {
+        return ProcessInfo.processInfo
+            .environment["CIRCLECI_TESTS_GENERATE_REVENUECAT_UI_SNAPSHOTS"] == "true"
     }
-
 }

Tests/StoreKitUnitTests/TestHelpers/ImageSnapshot.swift

@@ -32,7 +32,7 @@ func haveValidSnapshot<Value>(
         }
 
         guard let errorMessage = verifySnapshot(
-            matching: value,
+            of: value,
             as: strategy,
             named: name,
             record: recording,

Tests/UnitTests/Ads/Events/AdEventsRequestTests.swift

@@ -35,39 +35,39 @@ class AdFeatureEventsRequestTests: TestCase {
         let storedEvent = try Self.createStoredAdEvent(from: event)
         let requestEvent: AdEventsRequest.AdEventRequest = try XCTUnwrap(.init(storedEvent: storedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testLoadedEvent() throws {
         let event = AdEvent.loaded(Self.eventCreationData, Self.loadedData)
         let storedEvent = try Self.createStoredAdEvent(from: event)
         let requestEvent: AdEventsRequest.AdEventRequest = try XCTUnwrap(.init(storedEvent: storedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testDisplayedEvent() throws {
         let event = AdEvent.displayed(Self.eventCreationData, Self.eventData)
         let storedEvent = try Self.createStoredAdEvent(from: event)
         let requestEvent: AdEventsRequest.AdEventRequest = try XCTUnwrap(.init(storedEvent: storedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testOpenedEvent() throws {
         let event = AdEvent.opened(Self.eventCreationData, Self.openedData)
         let storedEvent = try Self.createStoredAdEvent(from: event)
         let requestEvent: AdEventsRequest.AdEventRequest = try XCTUnwrap(.init(storedEvent: storedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testRevenueEvent() throws {
         let event = AdEvent.revenue(Self.eventCreationData, Self.revenueData)
         let storedEvent = try Self.createStoredAdEvent(from: event)
         let requestEvent: AdEventsRequest.AdEventRequest = try XCTUnwrap(.init(storedEvent: storedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testCanInitFromDeserializedEvent() throws {
@@ -96,7 +96,7 @@ class AdFeatureEventsRequestTests: TestCase {
 
         let requestEvent = try XCTUnwrap(AdEventsRequest.AdEventRequest(storedEvent: deserializedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testAdEventWithoutMillisecondPrecisionIsParsed() throws {

Tests/UnitTests/CustomerCenter/Events/CustomerCenterEventsRequestTests.swift

@@ -38,7 +38,7 @@ class CustomerCenterFeatureEventsRequestTests: TestCase {
             FeatureEventsRequest.CustomerCenterEventBaseRequest.createBase(from: storedEvent)
         )
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testCanInitFromDeserializedEvent() throws {
@@ -69,7 +69,7 @@ class CustomerCenterFeatureEventsRequestTests: TestCase {
         let requestEvent =
         try XCTUnwrap(FeatureEventsRequest.CustomerCenterEventBaseRequest.createBase(from: deserializedEvent))
 
-        assertSnapshot(matching: requestEvent, as: .formattedJson)
+        assertSnapshot(of: requestEvent, as: .formattedJson)
     }
 
     func testCustomerCenterEventWithoutMillisecondPrecisionIsParsed() throws {

Tests/UnitTests/Misc/AnyEncodableTests.swift

@@ -12,6 +12,7 @@
 //  Created by Nacho Soto on 3/2/22.
 
 import Nimble
+import SnapshotTesting
 import XCTest
 
 @testable import RevenueCat
@@ -21,7 +22,7 @@ class AnyEncodableTests: TestCase {
     func testEmptyDictionary() {
         let empty: [String: Any] = [:]
 
-        assertSnapshot(matching: AnyEncodable(empty), as: .json)
+        assertSnapshot(of: AnyEncodable(empty), as: .json)
     }
 
     func testHomogenousDictionary() {
@@ -31,7 +32,7 @@ class AnyEncodableTests: TestCase {
             "c": "3"
         ]
 
-        assertSnapshot(matching: AnyEncodable(dictionary), as: .json)
+        assertSnapshot(of: AnyEncodable(dictionary), as: .json)
     }
 
     func testDictionaryWithDifferentValues() {
@@ -42,7 +43,7 @@ class AnyEncodableTests: TestCase {
             "d": nil
         ]
 
-        assertSnapshot(matching: AnyEncodable(dictionary), as: .json)
+        assertSnapshot(of: AnyEncodable(dictionary), as: .json)
     }
 
     func testNestedDictionary() throws {
@@ -64,7 +65,7 @@ class AnyEncodableTests: TestCase {
         ]
 
         assertSnapshot(
-            matching: AnyEncodable(dictionary),
+            of: AnyEncodable(dictionary),
             as: .json,
             // Formatting `Double`s changed in iOS 17
             testName: CurrentTestCaseTracker.osVersionAndTestName