chore: [SDK-5040] speed up iOS CI workflow and fix flakey tests

.github/workflows/ci.yml

@@ -8,28 +8,172 @@ on:
       - '.github/**'
       - 'README.md'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  KMP_XCFRAMEWORK_PATH: OneSignal-KMP-SDK/kmp/build/XCFrameworks/release/OneSignalKMP.xcframework
+
 jobs:
-  build:
-    name: Build and Test using any available iPhone simulator
-    runs-on: macos-15-large
+  lint:
+    name: Swift Lint
+    runs-on: macos-latest
 
     steps:
-      - name: Select Xcode Version
-        run: |
-          sudo xcode-select -s /Applications/Xcode_16.4.app/Contents/Developer
       - name: Checkout OneSignal-iOS-SDK
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
+      - name: Run Swift Lint
+        uses: cirruslabs/swiftlint-action@v1
+        with:
+          version: latest
+
+  kmp-xcframework:
+    name: Build OneSignalKMP XCFramework
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout OneSignal-iOS-SDK
+        uses: actions/checkout@v7
         with:
           submodules: recursive
+      - name: Create KMP cache key
+        id: kmp
+        run: |
+          kmp_sha="$(git rev-parse HEAD:OneSignal-KMP-SDK)"
+          xcode_hash="$(xcodebuild -version | shasum -a 256 | awk '{print $1}')"
+          echo "cache-key=kmp-xcframework-${{ runner.os }}-${{ runner.arch }}-${xcode_hash}-${kmp_sha}" >> "$GITHUB_OUTPUT"
+      - name: Restore OneSignalKMP XCFramework
+        id: kmp-cache
+        uses: actions/cache/restore@v6
+        with:
+          path: ${{ env.KMP_XCFRAMEWORK_PATH }}
+          key: ${{ steps.kmp.outputs.cache-key }}
       - name: Setup JDK 17
-        uses: actions/setup-java@v4
+        if: steps.kmp-cache.outputs.cache-hit != 'true'
+        uses: actions/setup-java@v5
         with:
           distribution: temurin
           java-version: "17"
       - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@v4
-      - name: Build OneSignalKMP XCFramework
-        run: iOS_SDK/OneSignalSDK/build_kmp_xcframework.sh
+        if: steps.kmp-cache.outputs.cache-hit != 'true'
+        uses: gradle/actions/setup-gradle@v6
+      - name: Assemble OneSignalKMP XCFramework
+        if: steps.kmp-cache.outputs.cache-hit != 'true'
+        run: |
+          iOS_SDK/OneSignalSDK/build_kmp_xcframework.sh \
+            :kmp:assembleOneSignalKMPReleaseXCFramework
+      - name: Save OneSignalKMP XCFramework
+        if: steps.kmp-cache.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v6
+        with:
+          path: ${{ env.KMP_XCFRAMEWORK_PATH }}
+          key: ${{ steps.kmp.outputs.cache-key }}
+      - name: Package OneSignalKMP XCFramework
+        run: |
+          tar -czf "$RUNNER_TEMP/OneSignalKMP.xcframework.tar.gz" \
+            -C "$(dirname "$KMP_XCFRAMEWORK_PATH")" \
+            "$(basename "$KMP_XCFRAMEWORK_PATH")"
+      - name: Upload OneSignalKMP XCFramework
+        uses: actions/upload-artifact@v7
+        with:
+          name: OneSignalKMP-XCFramework
+          path: ${{ runner.temp }}/OneSignalKMP.xcframework.tar.gz
+          retention-days: 1
+
+  ios-simulator:
+    name: Build and Test using any available iPhone simulator
+    runs-on: macos-latest
+    needs: kmp-xcframework
+
+    steps:
+      - name: Checkout OneSignal-iOS-SDK
+        uses: actions/checkout@v7
+      - name: Download OneSignalKMP XCFramework
+        uses: actions/download-artifact@v8
+        with:
+          name: OneSignalKMP-XCFramework
+          path: ${{ runner.temp }}
+      - name: Extract OneSignalKMP XCFramework
+        run: |
+          mkdir -p "$(dirname "$KMP_XCFRAMEWORK_PATH")"
+          tar -xzf "$RUNNER_TEMP/OneSignalKMP.xcframework.tar.gz" \
+            -C "$(dirname "$KMP_XCFRAMEWORK_PATH")"
+      - name: Select iPhone simulator
+        id: simulator
+        run: |
+          runtime_id="$(xcrun simctl list runtimes available --json | jq -r \
+            '[.runtimes[] | select(.platform == "iOS")] | sort_by(.version | split(".") | map(tonumber)) | last.identifier')"
+          device_id="$(xcrun simctl list devices available --json | jq -r --arg runtime "$runtime_id" \
+            '.devices[$runtime] | map(select(.name | startswith("iPhone"))) | first.udid')"
+          if [[ -z "$device_id" || "$device_id" == "null" ]]; then
+            echo "No available iPhone simulator found" >&2
+            exit 1
+          fi
+          echo "device-id=$device_id" >> "$GITHUB_OUTPUT"
+      - name: Build
+        env:
+          scheme: ${{ 'UnitTestApp' }}
+          file_to_build: ${{ 'iOS_SDK/OneSignalSDK/OneSignal.xcodeproj' }}
+          filetype_parameter: ${{ 'project' }}
+        run: |
+          xcodebuild build-for-testing \
+            -quiet \
+            -scheme "$scheme" \
+            -"$filetype_parameter" "$file_to_build" \
+            -destination "generic/platform=iOS Simulator" \
+            -enableCodeCoverage NO \
+            ARCHS=arm64 \
+            ONLY_ACTIVE_ARCH=YES
+      - name: Start simulator boot
+        env:
+          device_id: ${{ steps.simulator.outputs.device-id }}
+        run: |
+          device_state="$(xcrun simctl list devices --json | jq -r --arg device "$device_id" \
+            '[.devices[][] | select(.udid == $device)] | first.state')"
+          if [[ "$device_state" != "Booted" ]]; then
+            xcrun simctl boot "$device_id"
+          fi
+      - name: Wait for simulator boot
+        env:
+          device_id: ${{ steps.simulator.outputs.device-id }}
+        run: xcrun simctl bootstatus "$device_id" -b
+      - name: Test
+        env:
+          scheme: ${{ 'UnitTestApp' }}
+          test_plan: ${{ 'UnitTestApp_TestPlan_Reduced' }}
+          platform: ${{ 'iOS Simulator' }}
+          file_to_build: ${{ 'iOS_SDK/OneSignalSDK/OneSignal.xcodeproj' }}
+          filetype_parameter: ${{ 'project' }}
+          device_id: ${{ steps.simulator.outputs.device-id }}
+        run: |
+          xcodebuild test-without-building \
+            -quiet \
+            -scheme "$scheme" \
+            -testPlan "$test_plan" \
+            -"$filetype_parameter" "$file_to_build" \
+            -destination "platform=$platform,id=$device_id,arch=arm64" \
+            -maximum-parallel-testing-workers 1 \
+            -enableCodeCoverage NO
+
+  catalyst:
+    name: KMP logger Mac Catalyst integration
+    runs-on: macos-latest
+    needs: kmp-xcframework
+
+    steps:
+      - name: Checkout OneSignal-iOS-SDK
+        uses: actions/checkout@v7
+      - name: Download OneSignalKMP XCFramework
+        uses: actions/download-artifact@v8
+        with:
+          name: OneSignalKMP-XCFramework
+          path: ${{ runner.temp }}
+      - name: Extract OneSignalKMP XCFramework
+        run: |
+          mkdir -p "$(dirname "$KMP_XCFRAMEWORK_PATH")"
+          tar -xzf "$RUNNER_TEMP/OneSignalKMP.xcframework.tar.gz" \
+            -C "$(dirname "$KMP_XCFRAMEWORK_PATH")"
       - name: Archive OneSignalFramework for Catalyst
         run: |
           xcodebuild archive \
@@ -57,32 +201,3 @@ jobs:
             iOS_SDK/OneSignalSDK/CatalystLoggerHost/main.swift \
             -o "$host"
           DYLD_FRAMEWORK_PATH="$frameworks" "$host"
-      - name: Set Default Scheme
-        run: |
-          default="UnitTestApp"
-          echo $default | cat >default
-          echo Using default scheme: $default
-      - name: Run Swift Lint
-        run: |
-          swiftlint
-      - name: Build
-        env:
-          scheme: ${{ 'UnitTestApp' }}
-          platform: ${{ 'iOS Simulator' }}
-          file_to_build: ${{ 'iOS_SDK/OneSignalSDK/OneSignal.xcodeproj' }}
-          filetype_parameter: ${{ 'project' }}
-        run: |
-          # xcrun xctrace returns via stderr, not the expected stdout (see https://developer.apple.com/forums/thread/663959)
-          device=`xcrun xctrace list devices 2>&1 | grep -oE 'iPhone.*?[^\(]+' | head -1 | awk '{$1=$1;print}' | sed -e "s/ Simulator$//"`
-          xcodebuild build-for-testing -scheme "$scheme" -"$filetype_parameter" "$file_to_build" -destination "platform=$platform,name=$device"
-      - name: Test
-        env:
-          scheme: ${{ 'UnitTestApp' }}
-          test_plan: ${{ 'UnitTestApp_TestPlan_Reduced' }}
-          platform: ${{ 'iOS Simulator' }}
-          file_to_build: ${{ 'iOS_SDK/OneSignalSDK/OneSignal.xcodeproj' }}
-          filetype_parameter: ${{ 'project' }}
-        run: |
-          # xcrun xctrace returns via stderr, not the expected stdout (see https://developer.apple.com/forums/thread/663959)
-          device=`xcrun xctrace list devices 2>&1 | grep -oE 'iPhone.*?[^\(]+' | head -1 | awk '{$1=$1;print}' | sed -e "s/ Simulator$//"`
-          xcodebuild test-without-building -scheme "$scheme" -testPlan "$test_plan" -"$filetype_parameter" "$file_to_build" -destination "platform=$platform,name=$device"

.github/workflows/codeql.yml

@@ -14,12 +14,13 @@ name: "CodeQL"
 on:
   push:
     branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
   schedule:
     - cron: '35 6 * * 2'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   analyze:
     name: Analyze
@@ -46,11 +47,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v7
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -64,7 +65,7 @@ jobs:
     # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v4
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -77,6 +78,6 @@ jobs:
     #     ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v4
       with:
         category: "/language:${{matrix.language}}"

iOS_SDK/OneSignalSDK/OneSignalCoreMocks/MockOSDispatchQueue.swift

@@ -25,33 +25,43 @@
  THE SOFTWARE.
  */
 
+import Foundation
 import OneSignalOSCore
 
 public class MockDispatchQueue: OSDispatchQueue {
     let requestDispatch = DispatchQueue(label: "MockDispatchQueue")
-    var numDispatches = 0
+    private let dispatchCondition = NSCondition()
+    private var numDispatches = 0
 
     public init() {}
 
     public func async(execute work: @escaping @convention(block) () -> Void) {
         requestDispatch.async {
             work()
-            self.numDispatches += 1
+            self.recordDispatch()
         }
     }
 
     public func asyncAfterTime(deadline: DispatchTime, execute work: @escaping @Sendable @convention(block) () -> Void) {
         requestDispatch.asyncAfterTime(deadline: deadline) {
             work()
-            self.numDispatches += 1
+            self.recordDispatch()
         }
     }
 
     public func waitForDispatches(_ numDispatches: Int) {
+        dispatchCondition.lock()
+        defer { dispatchCondition.unlock() }
+
         while self.numDispatches < numDispatches {
-            requestDispatch.sync {
-                Thread.sleep(forTimeInterval: TimeInterval(1))
-            }
+            dispatchCondition.wait()
         }
     }
+
+    private func recordDispatch() {
+        dispatchCondition.lock()
+        numDispatches += 1
+        dispatchCondition.broadcast()
+        dispatchCondition.unlock()
+    }
 }

iOS_SDK/OneSignalSDK/OneSignalCoreMocks/MockOneSignalClient.swift

@@ -38,6 +38,7 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
     public var executedRequests: [OneSignalRequest] = []
     /// Requests that have entered `execute` (including those still held / delayed).
     public private(set) var startedRequests: [OneSignalRequest] = []
+    public private(set) var completedRequests: [OneSignalRequest] = []
     public var executeInstantaneously = false
     /// Set to true to make it unnecessary to setup mock responses for every request possible
     public var fireSuccessForAllRequests = false
@@ -91,6 +92,7 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
         networkRequestCount = 0
         executedRequests.removeAll()
         startedRequests.removeAll()
+        completedRequests.removeAll()
         heldExecutions.removeAll()
         holdResponses = false
         executeInstantaneously = true
@@ -181,6 +183,10 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
             allRequestsHandled = false
             print("🧪 cannot find a mock response for request: \(stringifiedRequest)")
         }
+
+        lock.withLock {
+            completedRequests.append(request)
+        }
     }
 
     func didCompleteRequest(_ request: OneSignalRequest) {
@@ -214,9 +220,10 @@ extension MockOneSignalClient {
      */
     @objc
     public func onlyOneRequest(contains path: String, contains payload: [String: Any]) -> Bool {
+        let requests = lock.withLock { executedRequests }
         var found = false
 
-        for request in executedRequests {
+        for request in requests {
             guard let params = request.parameters as? NSDictionary  else {
                 continue
             }
@@ -238,7 +245,8 @@ extension MockOneSignalClient {
     }
 
     public func hasExecutedRequestOfType(_ type: AnyClass, expectedCount: Int? = nil) -> Bool {
-        let matchingCount = executedRequests.filter { request in
+        let requests = lock.withLock { executedRequests }
+        let matchingCount = requests.filter { request in
             request.isKind(of: type)
         }.count
 
@@ -248,4 +256,27 @@ extension MockOneSignalClient {
             return matchingCount > 0
         }
     }
+
+    public func hasCompletedRequestOfType(_ type: AnyClass, expectedCount: Int? = nil) -> Bool {
+        let matchingCount = completedRequestCount(ofType: type)
+
+        if let expectedCount {
+            return matchingCount == expectedCount
+        }
+        return matchingCount > 0
+    }
+
+    public func completedRequestCount(ofType type: AnyClass) -> Int {
+        let requests = lock.withLock { completedRequests }
+        return requests.filter { request in
+            request.isKind(of: type)
+        }.count
+    }
+
+    public func startedRequestCount(ofType type: AnyClass) -> Int {
+        let requests = lock.withLock { startedRequests }
+        return requests.filter { request in
+            request.isKind(of: type)
+        }.count
+    }
 }