Merge branch 'master' into muzahid/update-license-year

Author: muzahidul-opti

.github/workflows/integration_tests.yml

@@ -5,9 +5,6 @@ on:
     secrets:
       CI_USER_TOKEN:
         required: true
-      TRAVIS_COM_TOKEN:
-        required: true
-
 jobs:
   integration_tests:
     runs-on: ubuntu-latest
@@ -16,8 +13,8 @@ jobs:
       with:
         # You should create a personal access token and store it in your repository
         token: ${{ secrets.CI_USER_TOKEN }}
-        repository: 'optimizely/travisci-tools'
-        path: 'home/runner/travisci-tools'
+        repository: 'optimizely/ci-helper-tools'
+        path: 'home/runner/ci-helper-tools'
         ref: 'master'
     - name: set SDK Branch if PR
       env: 
@@ -31,7 +28,6 @@ jobs:
       if: ${{ github.event_name != 'pull_request' }}
       run: |
         echo "SDK_BRANCH=$REF_NAME" >> $GITHUB_ENV
-        echo "TRAVIS_BRANCH=$REF_NAME" >> $GITHUB_ENV
     - name: Trigger build
       env:
         SDK: swift
@@ -41,14 +37,12 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.CI_USER_TOKEN }}
         EVENT_TYPE: ${{ github.event_name }}
         GITHUB_CONTEXT: ${{ toJson(github) }}
-        #REPO_SLUG: ${{ github.repository }}
         PULL_REQUEST_SLUG: ${{ github.repository }}
         UPSTREAM_REPO: ${{ github.repository }}
         PULL_REQUEST_SHA: ${{ github.event.pull_request.head.sha }}
         PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}
         UPSTREAM_SHA: ${{ github.sha }}
-        TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }}
         EVENT_MESSAGE: ${{ github.event.message }}
         HOME: 'home/runner'
       run: |
-        home/runner/travisci-tools/trigger-script-with-status-update.sh
+        home/runner/ci-helper-tools/trigger-script-with-status-update.sh

.github/workflows/source_clear_cron.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   source_clear:
-    runs-on: macos-12
+    runs-on: macos-13
     steps:
       - uses: actions/checkout@v3
       - name: Source clear scan

.github/workflows/swift.yml

@@ -17,7 +17,7 @@ on:
         description: release
 
 env:
-  VERSION: 4.1.0
+  VERSION: 5.1.0
 
 jobs:
 
@@ -29,10 +29,9 @@ jobs:
     uses: optimizely/swift-sdk/.github/workflows/integration_tests.yml@master
     secrets:
       CI_USER_TOKEN: ${{ secrets.CI_USER_TOKEN }}
-      TRAVIS_COM_TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }}
 
   lint: 
-    runs-on: macos-12
+    runs-on: macos-13
     steps:
     - uses: actions/checkout@v3
     - uses: maxim-lobanov/setup-xcode@v1
@@ -41,16 +40,15 @@ jobs:
     - env:
         SRCCLR_API_TOKEN: ${{ secrets.SRCCLR_API_TOKEN }}
       run: |
-        gem install cocoapods -v '1.9.3'
+        gem install cocoapods -v '1.15.2'
         pod spec lint --quick
         curl -sSL https://download.sourceclear.com/ci.sh | bash
 
   unittests: 
     if: "${{ github.event.inputs.PREP == '' && github.event.inputs.RELEASE == '' }}" 
     uses: optimizely/swift-sdk/.github/workflows/unit_tests.yml@master
-
   prepare_for_release:
-    runs-on: macos-12
+    runs-on: macos-13
     if: "${{ github.event.inputs.PREP == 'true' && github.event_name == 'workflow_dispatch' }}" 
     steps:
     - uses: actions/checkout@v3
@@ -69,7 +67,7 @@ jobs:
         BRANCH: ${{ github.ref_name }}
         GITHUB_USER: optibot
         GITHUB_TOKEN: ${{ secrets.CI_USER_TOKEN }}
-        COCOAPODS_VERSION: '1.12.1'
+        COCOAPODS_VERSION: '1.15.2'
       run: |
         gem install cocoapods -v $COCOAPODS_VERSION
         Scripts/run_prep.sh
@@ -79,7 +77,7 @@ jobs:
 
   release:
     if: "${{github.event.inputs.RELEASE == 'true' && github.event_name == 'workflow_dispatch' }}"
-    runs-on: macos-12
+    runs-on: macos-13
     steps:
     - uses: actions/checkout@v3
     - uses: maxim-lobanov/setup-xcode@v1
@@ -96,7 +94,7 @@ jobs:
         BRANCH: ${{ github.ref_name }}
         GITHUB_TOKEN: ${{ secrets.CI_USER_TOKEN }}
         COCOAPODS_TRUNK_TOKEN: ${{ secrets.COCOAPODS_TRUNK_TOKEN }}
-        COCOAPODS_VERSION: '1.12.1'
+        COCOAPODS_VERSION: '1.15.2'
       run: |
         gem install cocoapods -v $COCOAPODS_VERSION
         Scripts/run_release.sh

.github/workflows/unit_tests.yml

@@ -7,7 +7,7 @@ env:
 
 jobs:
   unittests:
-    runs-on: macos-12
+    runs-on: macos-13
     strategy:
       fail-fast: false
       matrix:
@@ -19,27 +19,27 @@ jobs:
         # - see "https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md" for installed macOS, xcode and simulator versions.
         include:
           - os: 16.1
-            device: "iPhone 12"
+            device: "iPhone 14"
             scheme: "OptimizelySwiftSDK-iOS"
             test_sdk: "iphonesimulator"
             platform: "iOS Simulator"
             os_type: "iOS"
             simulator_xcode_version: 14.1
-          - os: 15.5
-            device: "iPhone 12"
+          - os: 16.2
+            device: "iPhone 14"
             scheme: "OptimizelySwiftSDK-iOS"
             test_sdk: "iphonesimulator"
             platform: "iOS Simulator"
             os_type: "iOS"
-            simulator_xcode_version: 13.4.1
-          - os: 15.5
+            simulator_xcode_version: 14.2
+          - os: 16.4
             # good to have tests with older OS versions, but it looks like this is min OS+xcode versions supported by github actions
-            device: "iPad Air (4th generation)"
+            device: "iPad Air (5th generation)"
             scheme: "OptimizelySwiftSDK-iOS"
             test_sdk: "iphonesimulator"
             platform: "iOS Simulator"
             os_type: "iOS"
-            simulator_xcode_version: 13.4.1
+            simulator_xcode_version: 14.3.1
           - os: 16.1
             device: "Apple TV"
             scheme: "OptimizelySwiftSDK-tvOS"
@@ -76,7 +76,7 @@ jobs:
           NAME: ${{ matrix.device }}
         run: |
           gem install coveralls-lcov
-          gem install cocoapods -v '1.11.3'
+          gem install cocoapods -v '1.15.2'
           pod repo update
           pod install
           HOMEBREW_NO_INSTALL_CLEANUP=true brew update && brew install jq
@@ -85,7 +85,7 @@ jobs:
           # - to find pre-installed xcode version, run this:
           ##ls /Applications/
           # - to find supported simulator os versions, run this (and find simulator with non-error "datapath")
-          ##xcrun simctl list --json devices
+          # xcrun simctl list --json devices
 
           # switch to the target xcode version
           sudo xcode-select -switch /Applications/Xcode_$SIMULATOR_XCODE_VERSION.app

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Optimizely Swift SDK Changelog
 
+## 5.1.0
+February 4th, 2025
+
+### Functionality Enhancement
+* Add support for nested event tags ([#570](https://github.com/optimizely/swift-sdk/pull/570)).
+
+## 5.0.0
+November 25th, 2024
+
+### Breaking Changes
+* VUID configuration is now independent of ODP ([#456](https://github.com/optimizely/swift-sdk/pull/556))
+* When VUID is disabled:
+    * `vuid` is not generated or saved.
+    * `client-initialized` event will not auto fired on SDK init.
+    * `vuid` is not included in the odp events as a default attribute.
+    * `createUserContext()` will be rejected if `userId` is not provided.
+
 ## 4.1.0
 November 8, 2024
 

OptimizelySwiftSDK.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name                    = "OptimizelySwiftSDK"
   s.module_name	            = "Optimizely"
-  s.version                 = "4.1.0"
+  s.version                 = "5.1.0"
   s.summary                 = "Optimizely experiment framework for iOS/tvOS/watchOS"
   s.homepage                = "https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs"
   s.license                 = { :type => "Apache License, Version 2.0", :file => "LICENSE" }

README.md

@@ -39,7 +39,7 @@ If you have a name conflict with other swift packages when you add the Optimizel
 #### CocoaPods 
 1. Add the following lines to the _Podfile_:<pre>
 ```use_frameworks!```
-```pod 'OptimizelySwiftSDK', '~> 4.1.0'```
+```pod 'OptimizelySwiftSDK', '~> 5.1.0'```
 </pre>
 
 2. Run the following command: <pre>``` pod install ```</pre>
@@ -129,4 +129,4 @@ Used to enforce Swift style and conventions.
 
 - React - https://github.com/optimizely/react-sdk
 
-- Ruby - https://github.com/optimizely/ruby-sdk
+- Ruby - https://github.com/optimizely/ruby-sdk 

Sources/Data Model/Audience/AttributeValue.swift

@@ -17,11 +17,15 @@
 import Foundation
 
 enum AttributeValue: Codable, Equatable, CustomStringConvertible {
+    typealias AttrArray = Array<AttributeValue>
+    typealias AttrDictionary = [String : AttributeValue]
+    
     case string(String)
     case int(Int64)         // supported value range [-2^53, 2^53]
     case double(Double)
     case bool(Bool)
-    // not defined in datafile schema, but required for forward compatiblity (see Nikhil's doc)
+    case array(AttrArray)
+    case dictionary(AttrDictionary)
     case others
 
     var description: String {
@@ -34,6 +38,10 @@ enum AttributeValue: Codable, Equatable, CustomStringConvertible {
             return "int(\(value))"
         case .bool(let value):
             return "bool(\(value))"
+        case .array(let value):
+            return "array(\(value))"
+        case .dictionary(let value):
+            return "dictionary(\(value))"
         case .others:
             return "others"
         }
@@ -63,6 +71,18 @@ enum AttributeValue: Codable, Equatable, CustomStringConvertible {
             self = .bool(boolValue)
             return
         }
+        
+        if let arrValue = value as? [Any] {
+            let attr = arrValue.compactMap { AttributeValue(value: $0) }
+            self = .array(attr)
+            return
+        }
+        
+        if let dicValue = value as? [String : Any] {
+            let attr = dicValue.compactMapValues { AttributeValue(value: $0) }
+            self = .dictionary(attr)
+            return
+        }
 
         return nil
     }
@@ -87,7 +107,18 @@ enum AttributeValue: Codable, Equatable, CustomStringConvertible {
             return
         }
 
-        // accept all other types (null, {}, []) for forward compatibility support
+        if let value = try? container.decode(AttrArray.self) {
+            self = .array(value)
+            return
+        }
+        
+        if let value = try? container.decode(AttrDictionary.self) {
+            self = .dictionary(value)
+            return
+        }
+        
+        
+        // accept all other types (null) for forward compatibility support
         self = .others
     }
 
@@ -103,6 +134,10 @@ enum AttributeValue: Codable, Equatable, CustomStringConvertible {
             try container.encode(value)
         case .bool(let value):
             try container.encode(value)
+        case .array(let value):
+            try container.encode(value)
+        case .dictionary(let value):
+            try container.encode(value.mapValues { $0 })
         case .others:
             return
         }
@@ -135,6 +170,14 @@ extension AttributeValue {
             return true
         }
 
+        if case .array(let selfArr) = self, case .array(let targetArr) = targetValue {
+            return selfArr == targetArr
+        }
+        
+        if case .dictionary(let selfDict) = self, case .dictionary(let targetDict) = targetValue {
+            return selfDict == targetDict
+        }
+        
         return false
     }
 
@@ -227,6 +270,10 @@ extension AttributeValue {
             return String(value)
         case .bool(let value):
             return String(value)
+        case .array(let value):
+            return String(describing: value)
+        case .dictionary(let value):
+            return String(describing: value)
         case .others:
             return "UNKNOWN"
         }
@@ -240,6 +287,8 @@ extension AttributeValue {
         case (.double, .int): return true
         case (.double, .double): return true
         case (.bool, .bool): return true
+        case (.array, .array): return true
+        case (.dictionary, .dictionary): return true
         default: return false
         }
     }
@@ -271,6 +320,8 @@ extension AttributeValue {
         case (.int): return true
         case (.double): return true
         case (.bool): return true
+        case (.array): return true
+        case (.dictionary): return true
         default: return false
         }
     }

Sources/ODP/OdpManager.swift

@@ -57,7 +57,8 @@ public class OdpManager {
                                                                   cacheTimeoutInSecs: cacheTimeoutInSecs,
                                                                   resourceTimeoutInSecs: timeoutForSegmentFetchInSecs)
         self.eventManager = eventManager ?? OdpEventManager(sdkKey: sdkKey,
-                                                            resourceTimeoutInSecs: timeoutForEventDispatchInSecs)        
+                                                            resourceTimeoutInSecs: timeoutForEventDispatchInSecs)
+        
         self.odpConfig = OdpConfig()
         self.segmentManager.odpConfig = odpConfig
         self.eventManager.odpConfig = odpConfig
@@ -80,6 +81,12 @@ public class OdpManager {
                                                completionHandler: completionHandler)
     }
 
+    func sendInitializedEvent(vuid: String) throws {
+        guard enabled else { throw OptimizelyError.odpNotEnabled }
+        guard odpConfig.eventQueueingAllowed else { throw OptimizelyError.odpNotIntegrated }
+        eventManager.sendInitializedEvent(vuid: vuid)
+    }
+    
     func identifyUser(userId: String) {
         guard enabled else {
             logger.d("ODP identify event is not dispatched (ODP disabled).")

Sources/Optimizely+Decide/OptimizelyClient+Decide.swift

@@ -36,7 +36,7 @@ extension OptimizelyClient {
     /// - Parameter attributes: A map of attribute names to current user attribute values.
     /// - Returns: An OptimizelyUserContext associated with this OptimizelyClient
     public func createUserContext(attributes: [String: Any]? = nil) -> OptimizelyUserContext? {
-        guard enableVuid, let vuid = self.vuid else {
+        guard let vuid = self.vuid else {
             logger.e("Vuid is not enabled or invalid VUID. User context not created.")
             return nil
         }