Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,21 @@ jobs:
-"$filetype_parameter" "$file_to_build" \
-destination "platform=$platform,id=$device_id,arch=arm64" \
-maximum-parallel-testing-workers 1 \
-enableCodeCoverage NO
-enableCodeCoverage NO \
-resultBundlePath "$RUNNER_TEMP/UnitTests.xcresult"
- name: Print test failures
if: failure()
run: |
xcrun xcresulttool get test-results summary \
--path "$RUNNER_TEMP/UnitTests.xcresult" --format json \
| jq -r '.testFailures[]? | "::error title=\(.testName)::\(.failureText)"'
- name: Upload test results
if: failure()
uses: actions/upload-artifact@v7
with:
name: UnitTests-xcresult
path: ${{ runner.temp }}/UnitTests.xcresult
retention-days: 7

catalyst:
name: KMP logger Mac Catalyst integration
Expand Down
4 changes: 4 additions & 0 deletions iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,7 @@
91F60F7D1E80E4E400706E60 /* UncaughtExceptionHandler.m in Sources */ = {isa = PBXBuildFile; fileRef = 91F60F7C1E80E4E400706E60 /* UncaughtExceptionHandler.m */; };
9224347AAE3E092B5743380D /* UserJwtApiTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 80DC5517E6EB5B26CF980CC5 /* UserJwtApiTests.swift */; };
AE95DD5B72F1D102F6D6062A /* XCTestCase+AsyncWork.swift in Sources */ = {isa = PBXBuildFile; fileRef = 54FC986DDF6546AB251EA0A7 /* XCTestCase+AsyncWork.swift */; };
5663A0010000000000000001 /* OSUserExecutor+Snapshot.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5663A0010000000000000002 /* OSUserExecutor+Snapshot.swift */; };
94D9F5AFE86B16453A36C9A2 /* MockUserJwtInvalidatedListener.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1F214EE6C5FE133672D6622F /* MockUserJwtInvalidatedListener.swift */; };
99B1615D0132AFAA981A9AD3 /* DeltaOwnershipTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3881024646E7F0DE05158442 /* DeltaOwnershipTests.swift */; };
9D3300FA23149DAE000F0A83 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9D3300F923149DAE000F0A83 /* CoreGraphics.framework */; };
Expand Down Expand Up @@ -1707,6 +1708,7 @@
7AFE856E2368DDC50091D6A5 /* OSFocusCallParams.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSFocusCallParams.h; sourceTree = "<group>"; };
80DC5517E6EB5B26CF980CC5 /* UserJwtApiTests.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = UserJwtApiTests.swift; sourceTree = "<group>"; };
54FC986DDF6546AB251EA0A7 /* XCTestCase+AsyncWork.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = "XCTestCase+AsyncWork.swift"; sourceTree = "<group>"; };
5663A0010000000000000002 /* OSUserExecutor+Snapshot.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = "OSUserExecutor+Snapshot.swift"; sourceTree = "<group>"; };
8596A3E728FB90691E43BCA0 /* OSUrlPath.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = OSUrlPath.swift; sourceTree = "<group>"; };
89DE5BB0EDD3964C20C5169F /* OSIdentityModelRepoTests.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = OSIdentityModelRepoTests.swift; sourceTree = "<group>"; };
911E2CBA1E398AB3003112A4 /* UnitTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UnitTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
Expand Down Expand Up @@ -2572,6 +2574,7 @@
B5809B47EB4F2478099697CE /* OSUserJwtRepoTests.swift */,
80DC5517E6EB5B26CF980CC5 /* UserJwtApiTests.swift */,
54FC986DDF6546AB251EA0A7 /* XCTestCase+AsyncWork.swift */,
5663A0010000000000000002 /* OSUserExecutor+Snapshot.swift */,
3881024646E7F0DE05158442 /* DeltaOwnershipTests.swift */,
047D8F5E1095A20C9C54FD33 /* OSRequestAuthTests.swift */,
3016921C1F6B7B7793F67567 /* RequestPathEncodingTests.swift */,
Expand Down Expand Up @@ -4783,6 +4786,7 @@
2DB99C76F3532383C3B81D09 /* OSUserJwtRepoTests.swift in Sources */,
9224347AAE3E092B5743380D /* UserJwtApiTests.swift in Sources */,
AE95DD5B72F1D102F6D6062A /* XCTestCase+AsyncWork.swift in Sources */,
5663A0010000000000000001 /* OSUserExecutor+Snapshot.swift in Sources */,
99B1615D0132AFAA981A9AD3 /* DeltaOwnershipTests.swift in Sources */,
1B7E5A0AEB23050C398E6111 /* ExecutorAnonymousPurgeTests.swift in Sources */,
D9F1B3E5A7C2495FC1E6B8D3 /* ExecutorRequestAgingTests.swift in Sources */,
Expand Down
128 changes: 74 additions & 54 deletions iOS_SDK/OneSignalSDK/OneSignalCoreMocks/MockOneSignalClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,24 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
public let executionQueue: DispatchQueue = DispatchQueue(label: "com.onesignal.execution", attributes: .concurrent)
let lock = NSLock()

var mockResponses: [String: [String: Any]] = [:]
var mockFailureResponses: [String: OneSignalClientError] = [:]
public var lastHTTPRequest: OneSignalRequest?
public var networkRequestCount = 0
public var executedRequests: [OneSignalRequest] = []
// Tests read and configure these from the test thread while requests complete on `executionQueue`,
// so every access goes through `lock`.
private var mockResponses: [String: [String: Any]] = [:]
private var mockFailureResponses: [String: OneSignalClientError] = [:]
private var _lastHTTPRequest: OneSignalRequest?
private var _networkRequestCount = 0
private var _executedRequests: [OneSignalRequest] = []
private var _startedRequests: [OneSignalRequest] = []
private var _completedRequests: [OneSignalRequest] = []
private var _allRequestsHandled = true

public var lastHTTPRequest: OneSignalRequest? { lock.withLock { _lastHTTPRequest } }
public var networkRequestCount: Int { lock.withLock { _networkRequestCount } }
public var executedRequests: [OneSignalRequest] { lock.withLock { _executedRequests } }
/// Requests that have entered `execute` (including those still held / delayed).
public private(set) var startedRequests: [OneSignalRequest] = []
public private(set) var completedRequests: [OneSignalRequest] = []
public var startedRequests: [OneSignalRequest] { lock.withLock { _startedRequests } }
public var completedRequests: [OneSignalRequest] { lock.withLock { _completedRequests } }
public var allRequestsHandled: Bool { lock.withLock { _allRequestsHandled } }
public var executeInstantaneously = false
/// Set to true to make it unnecessary to setup mock responses for every request possible
public var fireSuccessForAllRequests = false
Expand All @@ -51,8 +61,6 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
var shouldUseProvisionalAuthorization = false // new in iOS 12 (aka Direct to History)
var remoteParamsOutcomes: [String: Any] = [:]

public var allRequestsHandled = true

/** May add to or change this default remote params response*/
public func getRemoteParamsResponse() -> [String: Any] {
return remoteParamsResponse ?? [
Expand Down Expand Up @@ -87,14 +95,16 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
}

public func reset() {
mockResponses = [:]
lastHTTPRequest = nil
networkRequestCount = 0
executedRequests.removeAll()
startedRequests.removeAll()
completedRequests.removeAll()
heldExecutions.removeAll()
holdResponses = false
lock.withLock {
mockResponses = [:]
_lastHTTPRequest = nil
_networkRequestCount = 0
_executedRequests.removeAll()
_startedRequests.removeAll()
_completedRequests.removeAll()
heldExecutions.removeAll()
holdResponses = false
}
executeInstantaneously = true
remoteParamsResponse = nil
shouldUseProvisionalAuthorization = false
Expand All @@ -106,7 +116,7 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {

// Check hold + enqueue under one lock so releaseHeldResponses can't miss a callback mid-hold.
let shouldHold = lock.withLock { () -> Bool in
startedRequests.append(request)
_startedRequests.append(request)
guard holdResponses else {
return false
}
Expand Down Expand Up @@ -154,49 +164,55 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
return stringified
}

func finishExecutingRequest(_ request: OneSignalRequest, onSuccess successBlock: OSResultSuccessBlock, onFailure failureBlock: OSClientFailureBlock) {
private enum MockOutcome {
case success([String: Any]?)
case failure(OneSignalClientError)
case unhandled
}

// TODO: This entire method needs to contained within the equivalent of @synchronized ❗️
func finishExecutingRequest(_ request: OneSignalRequest, onSuccess successBlock: OSResultSuccessBlock, onFailure failureBlock: OSClientFailureBlock) {
print("🧪 completing HTTP request: \(request)")

// TODO: Check for existence of app_id in the request and fail if not.
lock.withLock {
executedRequests.append(request)
let stringifiedRequest = stringify(request)
// Recording the request and choosing its response must be one step. Tests wait for a request to
// be executed and then register the response for its retry; if that landed in between, this
// attempt would be answered with the retry's response.
let outcome: MockOutcome = lock.withLock {
_executedRequests.append(request)
_networkRequestCount += 1
_lastHTTPRequest = request
if let response = mockResponses[stringifiedRequest] {
return .success(response)
} else if let error = mockFailureResponses[stringifiedRequest] {
return .failure(error)
} else if fireSuccessForAllRequests {
_allRequestsHandled = false
return .success([:])
} else {
_allRequestsHandled = false
return .unhandled
}
}

self.didCompleteRequest(request)
print("🧪 didCompleteRequest url: \(String(describing: request.urlRequest().url)) params: \(String(describing: request.parameters))")

let stringifiedRequest = stringify(request)
// Switch between types of requests with mock responses
if request.isKind(of: OSRequestGetIosParams.self) {
// send a mock remote params response
successBlock(["mockTodo": "responseTodo"])
}
if (mockResponses[stringifiedRequest]) != nil {
successBlock(mockResponses[stringifiedRequest])
} else if let response = mockFailureResponses[stringifiedRequest] {
failureBlock(response)
} else if fireSuccessForAllRequests {
allRequestsHandled = false
successBlock([:])
} else {
allRequestsHandled = false
switch outcome {
case .success(let response):
successBlock(response)
case .failure(let error):
failureBlock(error)
case .unhandled:
print("🧪 cannot find a mock response for request: \(stringifiedRequest)")
}

lock.withLock {
completedRequests.append(request)
_completedRequests.append(request)
}
}

func didCompleteRequest(_ request: OneSignalRequest) {
networkRequestCount += 1

print("🧪 didCompleteRequest url(\(networkRequestCount)): \(String(describing: request.urlRequest().url)) params: \(String(describing: request.parameters))")

lastHTTPRequest = request
}

/** This is not currently hooked up to anything to run */
@objc public func runBackgroundThreads() {
// Obj-C implementation: dispatch_sync(executionQueue, ^{})
Expand All @@ -206,13 +222,17 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
// A request has one outcome: whichever of these was called for it last. Otherwise a test could not
// override a default its setUp registered, nor let a retry succeed after the first attempt failed.
public func setMockResponseForRequest(request: String, response: [String: Any]) {
mockResponses[request] = response
mockFailureResponses.removeValue(forKey: request)
lock.withLock {
mockResponses[request] = response
mockFailureResponses.removeValue(forKey: request)
}
}

public func setMockFailureResponseForRequest(request: String, error: OneSignalClientError) {
mockFailureResponses[request] = error
mockResponses.removeValue(forKey: request)
lock.withLock {
mockFailureResponses[request] = error
mockResponses.removeValue(forKey: request)
}
}
}

Expand All @@ -224,7 +244,7 @@ extension MockOneSignalClient {
*/
@objc
public func onlyOneRequest(contains path: String, contains payload: [String: Any]) -> Bool {
let requests = lock.withLock { executedRequests }
let requests = executedRequests
var found = false

for request in requests {
Expand All @@ -249,7 +269,7 @@ extension MockOneSignalClient {
}

public func hasExecutedRequestOfType(_ type: AnyClass, expectedCount: Int? = nil) -> Bool {
let requests = lock.withLock { executedRequests }
let requests = executedRequests
let matchingCount = requests.filter { request in
request.isKind(of: type)
}.count
Expand All @@ -271,21 +291,21 @@ extension MockOneSignalClient {
}

public func completedRequestCount(ofType type: AnyClass) -> Int {
let requests = lock.withLock { completedRequests }
let requests = completedRequests
return requests.filter { request in
request.isKind(of: type)
}.count
}

public func startedRequestCount(ofType type: AnyClass) -> Int {
let requests = lock.withLock { startedRequests }
let requests = startedRequests
return requests.filter { request in
request.isKind(of: type)
}.count
}

/// Held requests count as in flight. Read under the lock, so safe from the test thread.
public var isIdle: Bool {
return lock.withLock { startedRequests.count == completedRequests.count }
return lock.withLock { _startedRequests.count == _completedRequests.count }
}
}
Loading
Loading