Merge pull request #835 from splitio/periodicRecorderWorker-module

Periodic recorder worker module

Author: MartinCardozo-SDK

.github/workflows/base_modules_ut.yaml

@@ -0,0 +1,45 @@
+name: Build and Test Modules UT
+
+on:
+  workflow_call:
+    inputs:
+      destination:
+        required: true
+        type: string
+      scheme:
+        description: The Xcode scheme to build and test (ModulesTestsSwift5 or ModulesTestsSwift6)
+        required: true
+        type: string
+
+jobs:
+  test:
+    runs-on: [macos-15-xlarge]
+
+    steps:
+      - name: Select Xcode
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: 16
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install xcbeautify
+        run: brew install xcbeautify
+
+      - name: Build and Test Modules
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 15
+          max_attempts: 3
+          command: |
+            set -o pipefail
+            xcodebuild test \
+              -project Split.xcodeproj \
+              -scheme ${{ inputs.scheme }} \
+              -destination '${{ inputs.destination }}' \
+              -testPlan TestPlans/ModulesTests \
+              -sdk iphonesimulator \
+              ONLY_ACTIVE_ARCH=NO | xcbeautify

.github/workflows/sonar.yml

@@ -30,7 +30,7 @@ jobs:
           xcodebuild -quiet test \
             -project Split.xcodeproj \
             -scheme Split \
-            -testPlan "SplitiOSFull" \
+            -testPlan "TestPlans/SplitiOSFull" \
             -destination 'platform=iOS Simulator,OS=18.5,name=iPhone 16' \
             -enableCodeCoverage YES \
             -resultBundlePath build/Logs/Test/TestResults.xcresult \

.github/workflows/test_all.yaml

@@ -17,21 +17,21 @@ jobs:
     strategy:
       matrix:
         plan: [
-          SplitiOSIntegration,
-          SplitiOSIntegration_1,
-          SplitiOSStreaming,
-          SplitiOSStreaming_1,
-          SplitiOSStreaming_2,
-          SplitiOSUnit,
-          SplitiOSUnit_1,
-          SplitiOSUnit_2,
-          SplitiOSUnit_3,
-          SplitiOSUnit_4,
-          SplitiOSUnit_5,
-          SemVer,
-          SplitPushManagerUT,
-          SplitStreamingUT,
-          SplitFlakyTests
+          TestPlans/SplitiOSIntegration,
+          TestPlans/SplitiOSIntegration_1,
+          TestPlans/SplitiOSStreaming,
+          TestPlans/SplitiOSStreaming_1,
+          TestPlans/SplitiOSStreaming_2,
+          TestPlans/SplitiOSUnit,
+          TestPlans/SplitiOSUnit_1,
+          TestPlans/SplitiOSUnit_2,
+          TestPlans/SplitiOSUnit_3,
+          TestPlans/SplitiOSUnit_4,
+          TestPlans/SplitiOSUnit_5,
+          TestPlans/SemVer,
+          TestPlans/SplitPushManagerUT,
+          TestPlans/SplitStreamingUT,
+          TestPlans/SplitFlakyTests
         ]
         scheme: [SplitTestsSwift5, SplitTestsSwift6]
       fail-fast: false
@@ -40,3 +40,13 @@ jobs:
       test-plan: ${{ matrix.plan }}
       destination: 'platform=iOS Simulator,OS=18.5,name=iPhone 16'
       scheme: ${{ matrix.scheme }}
+
+    modules-test:
+      strategy:
+        matrix:
+          scheme: [ModulesTestsSwift5, ModulesTestsSwift6]
+        fail-fast: false
+      uses: ./.github/workflows/base_modules_ut.yaml
+      with:
+        destination: 'platform=iOS Simulator,OS=18.5,name=iPhone 16'
+        scheme: ${{ matrix.scheme }}

Package.swift

@@ -8,11 +8,13 @@ let package = Package(
     products: [
         .library(name: "Split", targets: ["Split"]),
 
-        .library(name: "SplitCommons", targets: ["Logging", "Http", "BackoffCounter"]),],
+        .library(name: "SplitCommons", targets: ["Logging", "Http", "BackoffCounter", "PeriodicRecorderWorker"]),],
     targets: [
+        
+        // MARK: Split
         .target(
             name: "Split",
-            dependencies: ["Http", "BackoffCounter", "Logging"],
+            dependencies: ["Http", "BackoffCounter", "Logging", "PeriodicRecorderWorker"],
             path: "Split",
             exclude: [
                 "Common/Yaml/LICENSE",
@@ -21,6 +23,8 @@ let package = Package(
             ]
         ),
 
+        // MARK: External Modules
+        // Logging
         .target(
             name: "Logging",
             dependencies: [],
@@ -33,6 +37,7 @@ let package = Package(
             path: "Sources/Logging/Tests"
         ),
 
+        // Http
         .target(
             name: "Http",
             dependencies: ["Logging"],
@@ -45,6 +50,7 @@ let package = Package(
             path: "Sources/Http/Tests"
         ),
 
+        // BackoffCounter
         .target(
             name: "BackoffCounter",
             dependencies: ["Logging"],
@@ -53,9 +59,22 @@ let package = Package(
         ),
         .testTarget(
             name: "BackoffCounterTests",
-            dependencies: ["BackoffCounter"],
+            dependencies: [],
             path: "Sources/BackoffCounter/Tests"
         ),
+
+        // PeriodicRecorderWorker
+        .target(
+            name: "PeriodicRecorderWorker",
+            dependencies: [],
+            path: "Sources/PeriodicRecorderWorker",
+            exclude: ["Tests", "README.md"]
+        ),
+        .testTarget(
+            name: "PeriodicRecorderWorkerTests",
+            dependencies: ["PeriodicRecorderWorker"],
+            path: "Sources/PeriodicRecorderWorker/Tests"
+        ),
         // #INJECT_TARGET
     ]
 )

Sources/BackoffCounter/BackoffCounter.swift

@@ -23,6 +23,7 @@ public class DefaultBackoffCounter: BackoffCounter, @unchecked Sendable {
         }
     }
 
+    @discardableResult
     public func getNextRetryTime() -> Double {
         lock.lock()
         let currentAttempt = attemptCount

Sources/BackoffCounter/Tests/BackoffCounterTest.swift

@@ -3,9 +3,8 @@
 //  Copyright © 2020 Split. All rights reserved.
 
 import Foundation
-
 import XCTest
-@testable import Split
+@testable import BackoffCounter
 
 class BackoffCounterTest: XCTestCase {
 
@@ -37,7 +36,7 @@ class BackoffCounterTest: XCTestCase {
         let v4 = counter.getNextRetryTime()
 
         for _ in 0..<2000 {
-            _ = counter.getNextRetryTime()
+            counter.getNextRetryTime()
         }
         let vMax = counter.getNextRetryTime()
         counter.resetCounter();

Sources/Http/Endpoint.swift

@@ -1,10 +1,6 @@
-//
-//  Endpoint.swift
-// Http
-//
-// Created by Javier L. Avrudsky on 13/05/2020.
-// Copyright (c) 2020 Split. All rights reserved.
-//
+//  Endpoint
+//  Created by Javier L. Avrudsky on 13/05/2020.
+//  Copyright © 2020 Split. All rights reserved.
 
 import Foundation
 
@@ -33,8 +29,7 @@ public class Endpoint {
 
         if var queryString = defaultQueryString, let from = queryString.firstIndex(of: "&") {
             let upperLimit = queryString.index(from, offsetBy: 1)
-            queryString = queryString.replacingOccurrences(of: "&", with: "",
-                                                           options: .caseInsensitive, range: from..<upperLimit)
+            queryString = queryString.replacingOccurrences(of: "&", with: "", options: .caseInsensitive, range: from..<upperLimit)
             comp.query = queryString
         }
         self.url = comp.url ?? baseUrl
@@ -53,8 +48,7 @@ public class Endpoint {
         private var endpoint: Endpoint
 
         public init(baseUrl: URL, path: String?, isPathEncoded: Bool, defaultQueryString: String? = nil) {
-            endpoint = Endpoint(baseUrl: baseUrl, path: path,
-                                isPathEncoded: isPathEncoded, defaultQueryString: defaultQueryString)
+            endpoint = Endpoint(baseUrl: baseUrl, path: path, isPathEncoded: isPathEncoded, defaultQueryString: defaultQueryString)
         }
 
         public func add(header: String, withValue value: String) -> Self {

Sources/Http/HostDomainFilter.swift

@@ -1,10 +1,6 @@
-//
-//  HostsFilter.swift
-//  Http
-//
+//  HostDomainFilter
 //  Created by Javier Avrudsky on 30/07/2024.
 //  Copyright © 2024 Split. All rights reserved.
-//
 
 import Foundation
 
@@ -18,8 +14,7 @@ private extension String {
 public struct HostDomainFilter {
     public static let endString = "$"
     public static let mainRegex = "^(?:[a-zA-Z0-9_-]+\\.)"
-    public static let wildCards = [(prefix: "**.", pattern: "\(mainRegex)*"),
-                         (prefix: "*.", pattern: "\(mainRegex)?")]
+    public static let wildCards = [(prefix: "**.", pattern: "\(mainRegex)*"), (prefix: "*.", pattern: "\(mainRegex)?")]
 
     public static func pinsFor(host: String, pins: [CredentialPin]) -> [CredentialPin] {
         var foundPins = [CredentialPin]()

Sources/Http/HttpAuthenticator.swift

@@ -1,8 +1,9 @@
+//  HttpAuthenticator
 //  Protocol for handling HTTPS authentication challenges.
+//  Copyright © 2024 Split. All rights reserved.
 
 import Foundation
 
-/// Implementations can provide custom certificate validation, client certificate authentication, or other challenge responses.
 public protocol HttpAuthenticator: Sendable {
     func authenticate(session: URLSession,
                       challenge: URLAuthenticationChallenge,