(wip) validate 3.4.x

.travis.yml

@@ -24,18 +24,6 @@ jobs:
       notifications:
         email: false
 
-    - stage: 'Lint markdown files'
-      os: linux
-      language: generic
-      before_install: skip
-      install:
-        - npm i -g markdown-spellcheck
-      before_script:
-        - wget --quiet https://raw.githubusercontent.com/optimizely/mdspell-config/master/.spelling
-      script:
-        - mdspell -a -n -r --en-us '**/*.md'
-      after_success: skip
-
     - stage: 'Trigger Integration Tests'
       language: minimal
       os: linux
@@ -107,7 +95,7 @@ jobs:
       os: osx
       osx_image: xcode11.3
       env:
-        - VERSION=3.4.0
+        - VERSION=3.4.1
       install:
         # install hub
         - wget https://github.com/github/hub/releases/download/v2.11.2/hub-darwin-amd64-2.11.2.tgz -O /tmp/hub-darwin-amd64-2.11.2.tgz && tar -xvf /tmp/hub-darwin-amd64-2.11.2.tgz -C /usr/local/opt && ln -s /usr/local/opt/hub-darwin-amd64-2.11.2/bin/hub /usr/local/bin/hub
@@ -124,7 +112,7 @@ jobs:
       os: osx
       osx_image: xcode11.3
       env:
-        - VERSION=3.4.0
+        - VERSION=3.4.1
       install:
         # install hub
         - wget https://github.com/github/hub/releases/download/v2.11.2/hub-darwin-amd64-2.11.2.tgz -O /tmp/hub-darwin-amd64-2.11.2.tgz && tar -xvf /tmp/hub-darwin-amd64-2.11.2.tgz -C /usr/local/opt && ln -s /usr/local/opt/hub-darwin-amd64-2.11.2/bin/hub /usr/local/bin/hub

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Optimizely Swift SDK Changelog
 
+## 3.4.1
+September 22, 2020
+
+### Bug Fixes
+* Fix a bucketing error at traffic allocation boundaries. ([#365](https://github.com/optimizely/swift-sdk/pull/365))
+* Update DataStore directory on macOS. ([#355](https://github.com/optimizely/swift-sdk/pull/355))
+
 ## 3.4.0
 July 9, 2020
 

README.md

@@ -34,22 +34,22 @@ Please note below that _\<platform\>_ is used to represent the platform on which
 ```
 dependencies: [
 	.package(url: "https://github.com/optimizely/swift-sdk.git", 
-    .upToNextMinor(from: “3.4.0”))
+    .upToNextMinor(from: “3.4.1”))
 ]
 ```
 
 #### CocoaPods 
 1. Add the following lines to the _Podfile_:<pre>
 ```use_frameworks!```
-```pod 'OptimizelySwiftSDK', '~> 3.4.0'```
+```pod 'OptimizelySwiftSDK', '~> 3.4.1'```
 </pre>
 
 2. Run the following command: <pre>``` pod install ```</pre>
 
 Further installation instructions for Cocoapods: https://guides.cocoapods.org/using/getting-started.html
 
 #### Carthage
-1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" ~> 3.4.0```</pre>
+1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" ~> 3.4.1```</pre>
 
 2. Run the following command:<pre>```carthage update```</pre>
 

Sources/Implementation/Datastore/DataStoreFile.swift

@@ -29,7 +29,7 @@ public class DataStoreFile<T>: OPTDataStore where T: Codable {
         self.async = async
         dataStoreName = storeName
         lock = DispatchQueue(label: storeName)
-        #if os(tvOS)
+        #if os(tvOS) || os(macOS)
         let directory = FileManager.SearchPathDirectory.cachesDirectory
         #else
         let directory = FileManager.SearchPathDirectory.documentDirectory

Sources/Implementation/DefaultBucketer.swift

@@ -79,10 +79,7 @@ class DefaultBucketer: OPTBucketer {
             return nil
         }
 
-        for trafficAllocation in group.trafficAllocation where bucketValue <= trafficAllocation.endOfRange {
-            let experimentId = trafficAllocation.entityId
-
-            // propagate errors and logs for unknown experiment
+        if let experimentId = allocateTraffic(trafficAllocation: group.trafficAllocation, bucketValue: bucketValue) {
             if let experiment = config.getExperiment(id: experimentId) {
                 return experiment
             } else {
@@ -93,7 +90,7 @@ class DefaultBucketer: OPTBucketer {
 
         return nil
     }
-    
+
     func bucketToVariation(experiment: Experiment, bucketingId: String) -> Variation? {
         let hashId = makeHashIdFromBucketingId(bucketingId: bucketingId, entityId: experiment.id)
         let bucketValue = generateBucketValue(bucketingId: hashId)
@@ -103,17 +100,24 @@ class DefaultBucketer: OPTBucketer {
             logger.e(.experimentHasNoTrafficAllocation(experiment.key))
             return nil
         }
-
-        for trafficAllocation in experiment.trafficAllocation where bucketValue <= trafficAllocation.endOfRange {
-            let variationId = trafficAllocation.entityId
-
-            // propagate errors and logs for unknown variation
+
+        if let variationId = allocateTraffic(trafficAllocation: experiment.trafficAllocation, bucketValue: bucketValue) {
             if let variation = experiment.getVariation(id: variationId) {
                 return variation
             } else {
                 logger.e(.userBucketedIntoInvalidVariation(variationId))
                 return nil
             }
+        } else {
+            return nil
+        }
+    }
+
+    func allocateTraffic(trafficAllocation: [TrafficAllocation], bucketValue: Int) -> String? {
+        for bucket in trafficAllocation {
+            if bucketValue < bucket.endOfRange {
+                return bucket.entityId
+            }
         }
 
         return nil

Tests/OptimizelyTests-Common/BucketTests_Base.swift

@@ -41,4 +41,59 @@ class BucketTests_Base: XCTestCase {
         }
     }
 
+    func testAllocateExperimentTraffic() {
+        var experimentData: [String: Any] { return
+            [
+                "status": "Running",
+                "id": "12345",
+                "key": "experimentA",
+                "layerId": "10420273888",
+                "trafficAllocation": [
+                    [
+                        "entityId": "1000",
+                        "endOfRange": 0
+                    ],
+                    [
+                        "entityId": "1001",
+                        "endOfRange": 3000
+                    ],
+                    [
+                        "entityId": "1002",
+                        "endOfRange": 6000
+                    ]
+                ],
+                "audienceIds": [],
+                "variations": [
+                    [
+                        "variables": [],
+                        "id": "1000",
+                        "key": "a"
+                    ],
+                    [
+                        "variables": [],
+                        "id": "1001",
+                        "key": "b"
+                    ],
+                    [
+                        "variables": [],
+                        "id": "1002",
+                        "key": "c"
+                    ]
+                ],
+                "forcedVariations": [:]
+            ]
+        }
+
+        let bucketer = DefaultBucketer()
+        let experiment: Experiment = try! OTUtils.model(from: experimentData)
+        let trafficAllocation = experiment.trafficAllocation
+
+        XCTAssert(bucketer.allocateTraffic(trafficAllocation: trafficAllocation, bucketValue: 0) == "1001")
+        XCTAssert(bucketer.allocateTraffic(trafficAllocation: trafficAllocation, bucketValue: 2999) == "1001")
+        XCTAssert(bucketer.allocateTraffic(trafficAllocation: trafficAllocation, bucketValue: 3000) == "1002")
+        XCTAssert(bucketer.allocateTraffic(trafficAllocation: trafficAllocation, bucketValue: 5999) == "1002")
+        XCTAssertNil(bucketer.allocateTraffic(trafficAllocation: trafficAllocation, bucketValue: 6000))
+        XCTAssertNil(bucketer.allocateTraffic(trafficAllocation: trafficAllocation, bucketValue: 7000))
+    }
+
 }

Tests/OptimizelyTests-Common/BucketTests_Others.swift

@@ -176,7 +176,7 @@ extension BucketTests_Others {
 extension BucketTests_Others {
 
     func testBucketExperimentInMutexGroup() {        
-        let optimizely = OTUtils.createOptimizely(datafileName: "BucketerTestsDatafile", clearUserProfileService: true)!
+        let optimizely = OTUtils.createOptimizely(datafileName: "bucketer_test", clearUserProfileService: true)!
         let group = optimizely.config!.getGroup(id: "1886780721")!
 
         let bucketer = DefaultBucketer()
@@ -200,7 +200,7 @@ extension BucketTests_Others {
      }
 
     func testBucketReturnsNilWhenExperimentIsExcludedFromMutex() {
-        let optimizely = OTUtils.createOptimizely(datafileName: "BucketerTestsDatafile", clearUserProfileService: true)!
+        let optimizely = OTUtils.createOptimizely(datafileName: "bucketer_test", clearUserProfileService: true)!
         let config = optimizely.config!
         let bucketer = DefaultBucketer()
 
@@ -237,7 +237,7 @@ extension BucketTests_Others {
     }
 
     func testBucketExperimentWithMutexDoesNotChangeExperimentReference() {
-        let optimizely = OTUtils.createOptimizely(datafileName: "BucketerTestsDatafile", clearUserProfileService: true)!
+        let optimizely = OTUtils.createOptimizely(datafileName: "bucketer_test", clearUserProfileService: true)!
         let config = optimizely.config!
         let bucketer = DefaultBucketer()
 
@@ -248,7 +248,7 @@ extension BucketTests_Others {
     }
 
     func testBucketWithBucketingId() {
-        let optimizely = OTUtils.createOptimizely(datafileName: "BucketerTestsDatafile2", clearUserProfileService: true)!
+        let optimizely = OTUtils.createOptimizely(datafileName: "bucketer_test2", clearUserProfileService: true)!
         let config = optimizely.config!
         let bucketer = DefaultBucketer()
 
@@ -269,7 +269,7 @@ extension BucketTests_Others {
     func testBucketVariationGroupedExperimentsWithBucketingId() {
         // make sure that bucketing works with experiments in group
 
-        let optimizely = OTUtils.createOptimizely(datafileName: "BucketerTestsDatafile2", clearUserProfileService: true)!
+        let optimizely = OTUtils.createOptimizely(datafileName: "bucketer_test2", clearUserProfileService: true)!
         let config = optimizely.config!
         let bucketer = DefaultBucketer()
 
@@ -296,4 +296,16 @@ extension BucketTests_Others {
         XCTAssertNil(variation)
     }
 
+    func testBucketVariationAtBoundaries() {
+        // testing #OASIS-7150
+        // userId(2113143589306368718) + experId(18513703488) = “211314358930636871818513703488” creates a hash value of 0
+
+        let optimizely = OTUtils.createOptimizely(datafileName: "bucketer_test3", clearUserProfileService: true)!
+
+        XCTAssertFalse(optimizely.isFeatureEnabled(featureKey: "async_payments", userId: "2113143589306368718"))
+        XCTAssertFalse(optimizely.isFeatureEnabled(featureKey: "async_payments", userId: "2113143589306368719"))
+        XCTAssertFalse(optimizely.isFeatureEnabled(featureKey: "async_payments", userId: "2113143589306368710"))
+        XCTAssertFalse(optimizely.isFeatureEnabled(featureKey: "async_payments", userId: "2113143589306368711"))
+        XCTAssertFalse(optimizely.isFeatureEnabled(featureKey: "async_payments", userId: "2113143589306368712"))
+    }
 }

Tests/TestData/bucketer_test3.json

@@ -0,0 +1,51 @@
+{
+    "version": "4",
+    "rollouts": [
+        {
+            "experiments": [
+                {
+                    "status": "Running",
+                    "audienceIds": [ ],
+                    "variations": [
+                        {
+                            "variables": [ ],
+                            "id": "18532971919",
+                            "key": "18532971919",
+                            "featureEnabled": true
+                        }
+                    ],
+                    "id": "18513703488",
+                    "key": "18513703488",
+                    "layerId": "18513932701",
+                    "trafficAllocation": [
+                        {
+                            "entityId": "18532971919",
+                            "endOfRange": 0
+                        }
+                    ],
+                    "forcedVariations": { }
+                }
+            ],
+            "id": "18513932701"
+        }
+    ],
+    "anonymizeIP": true,
+    "projectId": "10431130345",
+    "variables": [],
+    "featureFlags": [
+        {
+            "experimentIds": [],
+            "rolloutId": "18513932701",
+            "variables": [],
+            "id": "18533552281",
+            "key": "async_payments"
+        }
+    ],
+    "experiments": [],
+    "audiences": [],
+    "groups": [],
+    "attributes": [],
+    "accountId": "10367498574",
+    "events": [],
+    "revision": "100"
+}