Merge pull request #8825 from woocommerce/merge/12.1-final-into-trunk

Merge 12.1 final into trunk

Author: spencertransier

Experiments/Experiments.xcodeproj/project.pbxproj

@@ -17,6 +17,10 @@
 		C8E16F0EE6954B58A1C402F0 /* Pods_ExperimentsTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = AAC7C082DD376957B4676401 /* Pods_ExperimentsTests.framework */; };
 		CC53FB48275E426900C4CA4F /* ABTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC53FB47275E426900C4CA4F /* ABTest.swift */; };
 		EE2EDFDF29879331004E702B /* ABTestVariationProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = EE2EDFDE29879331004E702B /* ABTestVariationProvider.swift */; };
+		EEC8C0ED298A92F10047B4CB /* CachedABTestVariationProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEC8C0EC298A92F10047B4CB /* CachedABTestVariationProvider.swift */; };
+		EEC8C0EF298A939C0047B4CB /* VariationCache.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEC8C0EE298A939C0047B4CB /* VariationCache.swift */; };
+		EEC8C0F1298B5AFB0047B4CB /* VariationCacheTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEC8C0F0298B5AFB0047B4CB /* VariationCacheTests.swift */; };
+		EEC8C0F3298B5F950047B4CB /* CachedABTestVariationProviderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEC8C0F2298B5F950047B4CB /* CachedABTestVariationProviderTests.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -49,6 +53,10 @@
 		AF72D9DB7771E7A5105C88B0 /* Pods-Experiments.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Experiments.release.xcconfig"; path = "Target Support Files/Pods-Experiments/Pods-Experiments.release.xcconfig"; sourceTree = "<group>"; };
 		CC53FB47275E426900C4CA4F /* ABTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ABTest.swift; sourceTree = "<group>"; };
 		EE2EDFDE29879331004E702B /* ABTestVariationProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ABTestVariationProvider.swift; sourceTree = "<group>"; };
+		EEC8C0EC298A92F10047B4CB /* CachedABTestVariationProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CachedABTestVariationProvider.swift; sourceTree = "<group>"; };
+		EEC8C0EE298A939C0047B4CB /* VariationCache.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VariationCache.swift; sourceTree = "<group>"; };
+		EEC8C0F0298B5AFB0047B4CB /* VariationCacheTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VariationCacheTests.swift; sourceTree = "<group>"; };
+		EEC8C0F2298B5F950047B4CB /* CachedABTestVariationProviderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CachedABTestVariationProviderTests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -103,6 +111,8 @@
 				0270C0A627069BA500FC799F /* BuildConfiguration.swift */,
 				CC53FB47275E426900C4CA4F /* ABTest.swift */,
 				EE2EDFDE29879331004E702B /* ABTestVariationProvider.swift */,
+				EEC8C0EC298A92F10047B4CB /* CachedABTestVariationProvider.swift */,
+				EEC8C0EE298A939C0047B4CB /* VariationCache.swift */,
 			);
 			path = Experiments;
 			sourceTree = "<group>";
@@ -111,6 +121,8 @@
 			isa = PBXGroup;
 			children = (
 				0270C09127069A8900FC799F /* Info.plist */,
+				EEC8C0F0298B5AFB0047B4CB /* VariationCacheTests.swift */,
+				EEC8C0F2298B5F950047B4CB /* CachedABTestVariationProviderTests.swift */,
 			);
 			path = ExperimentsTests;
 			sourceTree = "<group>";
@@ -206,6 +218,7 @@
 					};
 					0270C08927069A8900FC799F = {
 						CreatedOnToolsVersion = 12.5.1;
+						LastSwiftMigration = 1420;
 					};
 				};
 			};
@@ -314,11 +327,13 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				EEC8C0EF298A939C0047B4CB /* VariationCache.swift in Sources */,
 				0270C0A327069B7800FC799F /* FeatureFlagService.swift in Sources */,
 				0270C0A527069B8900FC799F /* DefaultFeatureFlagService.swift in Sources */,
 				0270C09C27069AE700FC799F /* FeatureFlag.swift in Sources */,
 				EE2EDFDF29879331004E702B /* ABTestVariationProvider.swift in Sources */,
 				0270C0A727069BA500FC799F /* BuildConfiguration.swift in Sources */,
+				EEC8C0ED298A92F10047B4CB /* CachedABTestVariationProvider.swift in Sources */,
 				CC53FB48275E426900C4CA4F /* ABTest.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -327,6 +342,8 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				EEC8C0F1298B5AFB0047B4CB /* VariationCacheTests.swift in Sources */,
+				EEC8C0F3298B5F950047B4CB /* CachedABTestVariationProviderTests.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -521,6 +538,7 @@
 			baseConfigurationReference = 3022E2766134CE2735C73FC6 /* Pods-ExperimentsTests.debug.xcconfig */;
 			buildSettings = {
 				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = "${inherited}";
+				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = ExperimentsTests/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (
@@ -530,6 +548,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = com.automattic.ExperimentsTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
@@ -540,6 +559,7 @@
 			baseConfigurationReference = 7C831644164B49828A485590 /* Pods-ExperimentsTests.release.xcconfig */;
 			buildSettings = {
 				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = "${inherited}";
+				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = ExperimentsTests/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (
@@ -644,6 +664,7 @@
 			baseConfigurationReference = 3F9DB5FBFF7A42EFBCB746F3 /* Pods-ExperimentsTests.release-alpha.xcconfig */;
 			buildSettings = {
 				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = "${inherited}";
+				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_STYLE = Automatic;
 				INFOPLIST_FILE = ExperimentsTests/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (

Experiments/Experiments/ABTest.swift

@@ -2,10 +2,9 @@ import AutomatticTracks
 
 /// ABTest adds A/B testing experiments and runs the tests based on their variations from the ExPlat service.
 ///
-public enum ABTest: String, CaseIterable {
-    /// Throwaway case, to prevent a compiler error:
-    /// `An enum with no cases cannot declare a raw type`
-    case null
+public enum ABTest: String, Codable, CaseIterable {
+    /// Mocks for unit testing
+    case mockLoggedIn, mockLoggedOut
 
     /// A/A test to make sure there is no bias in the logged out state.
     /// Experiment ref: pbxNRc-1QS-p2
@@ -21,8 +20,8 @@ public enum ABTest: String, CaseIterable {
 
     /// Returns a variation for the given experiment
     ///
-    var variation: Variation {
-        ExPlat.shared?.experiment(rawValue) ?? .control
+    public var variation: Variation? {
+        ExPlat.shared?.experiment(rawValue)
     }
 
     /// Returns the context for the given experiment.
@@ -34,18 +33,27 @@ public enum ABTest: String, CaseIterable {
             return .loggedIn
         case .aaTestLoggedOut, .applicationPasswordAuthentication:
             return .loggedOut
-        case .null:
-            return .none
+        // Mocks
+        case .mockLoggedIn:
+            return .loggedIn
+        case .mockLoggedOut:
+            return .loggedOut
         }
     }
+
+    // Returns only the genuine ABTest cases. (After removing unit test mocks)
+    //
+    static var genuineCases: [ABTest] {
+        ABTest.allCases.filter { [.mockLoggedIn, .mockLoggedOut].contains($0) == false }
+    }
 }
 
 public extension ABTest {
     /// Start the AB Testing platform if any experiment exists for the provided context
     ///
     @MainActor
     static func start(for context: ExperimentContext) async {
-        let experiments = ABTest.allCases.filter { $0.context == context }
+        let experiments = ABTest.genuineCases.filter { $0.context == context }
 
         await withCheckedContinuation { continuation in
             guard !experiments.isEmpty else {

Experiments/Experiments/ABTestVariationProvider.swift

@@ -11,6 +11,6 @@ public struct DefaultABTestVariationProvider: ABTestVariationProvider {
     public init() { }
 
     public func variation(for abTest: ABTest) -> Variation {
-        abTest.variation
+        abTest.variation ?? .control
     }
 }

Experiments/Experiments/CachedABTestVariationProvider.swift

@@ -0,0 +1,30 @@
+import AutomatticTracks
+
+/// Cache based implementation of `ABTestVariationProvider`
+///
+public struct CachedABTestVariationProvider: ABTestVariationProvider {
+
+    private let cache: VariationCache
+
+    public init(cache: VariationCache = VariationCache(userDefaults: .standard)) {
+        self.cache = cache
+    }
+
+    public func variation(for abTest: ABTest) -> Variation {
+        // We cache only logged out ABTests as they are assigned based on `anonId` by `ExPlat`.
+        // There will be one value assigned to one device and it won't change.
+        //
+        guard abTest.context == .loggedOut else {
+            return abTest.variation ?? .control
+        }
+
+        if let variation = abTest.variation {
+            try? cache.assign(variation: variation, for: abTest)
+            return variation
+        } else if let cachedVariation = cache.variation(for: abTest) {
+            return cachedVariation
+        } else {
+            return .control
+        }
+    }
+}

Experiments/Experiments/VariationCache.swift

@@ -0,0 +1,47 @@
+import AutomatticTracks
+
+enum VariationCacheError: Error {
+    case onlyLoggedOutExperimentsShouldBeCached
+}
+
+public struct VariationCache {
+    private let variationKey = "VariationCacheKey"
+
+    private let userDefaults: UserDefaults
+
+    public init(userDefaults: UserDefaults) {
+        self.userDefaults = userDefaults
+    }
+
+    func variation(for abTest: ABTest) -> Variation? {
+        guard abTest.context == .loggedOut else {
+            return nil
+        }
+
+        guard let data = userDefaults.object(forKey: variationKey) as? Data,
+              let cachedVariations = try? JSONDecoder().decode([CachedVariation].self, from: data),
+              case let variation = cachedVariations.first(where: { $0.abTest == abTest })?.variation
+        else {
+            return nil
+        }
+
+        return variation
+    }
+
+    func assign(variation: Variation, for abTest: ABTest) throws {
+        guard abTest.context == .loggedOut else {
+            throw VariationCacheError.onlyLoggedOutExperimentsShouldBeCached
+        }
+
+        var variations = userDefaults.object(forKey: variationKey) as? [CachedVariation] ?? []
+        variations.append(CachedVariation(abTest: abTest, variation: variation))
+
+        let encodedVariation = try JSONEncoder().encode(variations)
+        userDefaults.set(encodedVariation, forKey: variationKey)
+    }
+}
+
+public struct CachedVariation: Codable {
+    let abTest: ABTest
+    let variation: Variation
+}

Experiments/ExperimentsTests/CachedABTestVariationProviderTests.swift

@@ -0,0 +1,29 @@
+import XCTest
+@testable import Experiments
+
+final class CachedABTestVariationProviderTests: XCTestCase {
+    func test_variation_is_control_when_the_value_does_not_exist() throws {
+        // Given
+        let userDefaults = try XCTUnwrap(UserDefaults(suiteName: UUID().uuidString))
+
+        // When
+        let cache = VariationCache(userDefaults: userDefaults)
+        let provider = CachedABTestVariationProvider(cache: cache)
+
+        // Then
+        XCTAssertEqual(provider.variation(for: .mockLoggedOut), .control)
+    }
+
+    func test_correct_variation_is_returned_after_caching_it() throws {
+        // Given
+        let userDefaults = try XCTUnwrap(UserDefaults(suiteName: UUID().uuidString))
+        let cache = VariationCache(userDefaults: userDefaults)
+        let provider = CachedABTestVariationProvider(cache: cache)
+
+        // When
+        try cache.assign(variation: .treatment, for: .mockLoggedOut)
+
+        // Then
+        XCTAssertEqual(provider.variation(for: .mockLoggedOut), .treatment)
+    }
+}

Experiments/ExperimentsTests/VariationCacheTests.swift

@@ -0,0 +1,36 @@
+import XCTest
+@testable import Experiments
+
+final class VariationCacheTests: XCTestCase {
+    func test_variation_is_nil_when_the_value_does_not_exist() throws {
+        // Given
+        let userDefaults = try XCTUnwrap(UserDefaults(suiteName: UUID().uuidString))
+
+        // When
+        let cache = VariationCache(userDefaults: userDefaults)
+
+        // Then
+        XCTAssertNil(cache.variation(for: .mockLoggedOut))
+    }
+
+    func test_correct_variation_is_returned_after_setting_it() throws {
+        // Given
+        let userDefaults = try XCTUnwrap(UserDefaults(suiteName: UUID().uuidString))
+        let cache = VariationCache(userDefaults: userDefaults)
+
+        // When
+        try cache.assign(variation: .treatment, for: .mockLoggedOut)
+
+        // Then
+        XCTAssertEqual(cache.variation(for: .mockLoggedOut), .treatment)
+    }
+
+    func test_it_throws_when_trying_to_cache_logged_in_experiment() throws {
+        // Given
+        let userDefaults = try XCTUnwrap(UserDefaults(suiteName: UUID().uuidString))
+        let cache = VariationCache(userDefaults: userDefaults)
+
+        // When
+        XCTAssertThrowsError(try cache.assign(variation: .treatment, for: .mockLoggedIn))
+    }
+}

Podfile

@@ -27,7 +27,7 @@ def aztec
 end
 
 def tracks
-  pod 'Automattic-Tracks-iOS', '~> 1.0.0'
+  pod 'Automattic-Tracks-iOS', '~> 2.0.0-beta.1'
   # pod 'Automattic-Tracks-iOS', :git => 'https://github.com/Automattic/Automattic-Tracks-iOS.git', :branch => 'trunk'
   # pod 'Automattic-Tracks-iOS', :git => 'https://github.com/Automattic/Automattic-Tracks-iOS.git', :commit => ''
   # pod 'Automattic-Tracks-iOS', :path => '../Automattic-Tracks-iOS'

Podfile.lock

@@ -6,7 +6,7 @@ PODS:
   - AppAuth/Core (1.6.0)
   - AppAuth/ExternalUserAgent (1.6.0):
     - AppAuth/Core
-  - Automattic-Tracks-iOS (1.0.0):
+  - Automattic-Tracks-iOS (2.0.0-beta.1):
     - Sentry (~> 7.25)
     - Sodium (>= 0.9.1)
     - UIDeviceIdentifier (~> 2.0)
@@ -75,7 +75,7 @@ PODS:
 
 DEPENDENCIES:
   - Alamofire (~> 4.8)
-  - Automattic-Tracks-iOS (~> 1.0.0)
+  - Automattic-Tracks-iOS (~> 2.0.0-beta.1)
   - CocoaLumberjack (~> 3.7.4)
   - CocoaLumberjack/Swift (~> 3.7.4)
   - Gridicons (~> 1.2.0)
@@ -144,7 +144,7 @@ CHECKOUT OPTIONS:
 SPEC CHECKSUMS:
   Alamofire: 3ec537f71edc9804815215393ae2b1a8ea33a844
   AppAuth: 8fca6b5563a5baef2c04bee27538025e4ceb2add
-  Automattic-Tracks-iOS: 93df154824af31eba947718110023acce1ce7905
+  Automattic-Tracks-iOS: 20220d63a075787a890513ae56214a17a160ec43
   CocoaLumberjack: 543c79c114dadc3b1aba95641d8738b06b05b646
   GoogleSignIn: fd381840dbe7c1137aa6dc30849a5c3e070c034a
   Gridicons: 4455b9f366960121430e45997e32112ae49ffe1d
@@ -178,6 +178,6 @@ SPEC CHECKSUMS:
   ZendeskSupportProvidersSDK: 2bdf8544f7cd0fd4c002546f5704b813845beb2a
   ZendeskSupportSDK: 3a8e508ab1d9dd22dc038df6c694466414e037ba
 
-PODFILE CHECKSUM: 74b7cf5dee0b25888c6c3b52ade928cf52818407
+PODFILE CHECKSUM: edd03ed08aa5c68531f27bdd04f1c0b846f98749
 
 COCOAPODS: 1.11.3