1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
final class DummyObject : NSObject, Sendable { }
class TestNotificationQueue : XCTestCase {
func test_defaultQueue() {
nonisolated(unsafe) let defaultQueue1 = NotificationQueue.default
let defaultQueue2 = NotificationQueue.default
XCTAssertEqual(defaultQueue1, defaultQueue2)
executeInBackgroundThread() {
let defaultQueueForBackgroundThread = NotificationQueue.default
XCTAssertEqual(defaultQueueForBackgroundThread, NotificationQueue.default)
XCTAssertNotEqual(defaultQueueForBackgroundThread, defaultQueue1)
}
}
func test_postNowToDefaultQueueWithoutCoalescing() {
let notificationName = Notification.Name(rawValue: "test_postNowWithoutCoalescing")
let dummyObject = DummyObject()
let notification = Notification(name: notificationName, object: dummyObject)
nonisolated(unsafe) var numberOfCalls = 0
let obs = NotificationCenter.default.addObserver(forName: notificationName, object: dummyObject, queue: nil) { notification in
numberOfCalls += 1
}
let queue = NotificationQueue.default
queue.enqueue(notification, postingStyle: .now)
XCTAssertEqual(numberOfCalls, 1)
NotificationCenter.default.removeObserver(obs)
}
func test_postNowToDefaultQueueWithCoalescing() {
let notificationName = Notification.Name(rawValue: "test_postNowToDefaultQueueWithCoalescingOnName")
let dummyObject = DummyObject()
let notification = Notification(name: notificationName, object: dummyObject)
nonisolated(unsafe) var numberOfCalls = 0
let obs = NotificationCenter.default.addObserver(forName: notificationName, object: dummyObject, queue: nil) { notification in
numberOfCalls += 1
}
let queue = NotificationQueue.default
queue.enqueue(notification, postingStyle: .now)
queue.enqueue(notification, postingStyle: .now)
queue.enqueue(notification, postingStyle: .now)
// Coalescing doesn't work for the NSPostingStyle.PostNow. That is why we expect 3 calls here
XCTAssertEqual(numberOfCalls, 3)
NotificationCenter.default.removeObserver(obs)
}
func test_postNowToCustomQueue() {
let notificationName = Notification.Name(rawValue: "test_postNowToCustomQueue")
let dummyObject = DummyObject()
let notification = Notification(name: notificationName, object: dummyObject)
nonisolated(unsafe) var numberOfCalls = 0
let notificationCenter = NotificationCenter()
let obs = notificationCenter.addObserver(forName: notificationName, object: dummyObject, queue: nil) { notification in
numberOfCalls += 1
}
let notificationQueue = NotificationQueue(notificationCenter: notificationCenter)
notificationQueue.enqueue(notification, postingStyle: .now)
XCTAssertEqual(numberOfCalls, 1)
NotificationCenter.default.removeObserver(obs)
}
func test_postNowForDefaultRunLoopMode() {
let notificationName = Notification.Name(rawValue: "test_postNowToDefaultQueueWithCoalescingOnName")
let dummyObject = DummyObject()
nonisolated(unsafe) var numberOfCalls = 0
let obs = NotificationCenter.default.addObserver(forName: notificationName, object: dummyObject, queue: nil) { notification in
numberOfCalls += 1
}
let endDate = Date(timeInterval: TimeInterval(0.05), since: Date())
let dummyTimer = Timer.scheduledTimer(withTimeInterval: 0.01, repeats: false) { _ in
guard let runLoopMode = RunLoop.current.currentMode else {
return
}
let queue = NotificationQueue.default
let notification = Notification(name: notificationName, object: dummyObject)
// post 2 notifications for the RunLoop.Mode.default mode
queue.enqueue(notification, postingStyle: .now, coalesceMask: [], forModes: [runLoopMode])
queue.enqueue(notification, postingStyle: .now)
// here we post notification for the RunLoop.Mode.common. It shouldn't have any affect, because the timer is scheduled in RunLoop.Mode.default.
// The notification queue will only post the notification to its notification center if the run loop is in one of the modes provided in the array.
queue.enqueue(notification, postingStyle: .now, coalesceMask: [], forModes: [.common])
}
RunLoop.current.add(dummyTimer, forMode: .default)
let _ = RunLoop.current.run(mode: .default, before: endDate)
XCTAssertEqual(numberOfCalls, 2)
NotificationCenter.default.removeObserver(obs)
}
func test_postAsapToDefaultQueue() {
let notificationName = Notification.Name(rawValue: "test_postAsapToDefaultQueue")
let dummyObject = DummyObject()
let notification = Notification(name: notificationName, object: dummyObject)
nonisolated(unsafe) var numberOfCalls = 0
let obs = NotificationCenter.default.addObserver(forName: notificationName, object: dummyObject, queue: nil) { notification in
numberOfCalls += 1
}
let queue = NotificationQueue.default
queue.enqueue(notification, postingStyle: .asap)
scheduleTimer(withInterval: 0.001) // run timer trigger the notifications
XCTAssertEqual(numberOfCalls, 1)
NotificationCenter.default.removeObserver(obs)
}
func test_postAsapToDefaultQueueWithCoalescingOnNameAndSender() {
// Check coalescing on name and object
let notificationName = Notification.Name(rawValue: "test_postAsapToDefaultQueueWithCoalescingOnNameAndSender")
let notification = Notification(name: notificationName, object: DummyObject())
nonisolated(unsafe) var numberOfCalls = 0
let obs = NotificationCenter.default.addObserver(forName: notificationName, object: notification.object, queue: nil) { notification in
numberOfCalls += 1
}
let queue = NotificationQueue.default
queue.enqueue(notification, postingStyle: .asap)
queue.enqueue(notification, postingStyle: .asap)
queue.enqueue(notification, postingStyle: .asap)
scheduleTimer(withInterval: 0.001)
XCTAssertEqual(numberOfCalls, 1)
NotificationCenter.default.removeObserver(obs)
}
func test_postAsapToDefaultQueueWithCoalescingOnNameOrSender() {
// Check coalescing on name or sender
let notificationName = Notification.Name(rawValue: "test_postAsapToDefaultQueueWithCoalescingOnNameOrSender")
let notification1 = Notification(name: notificationName, object: DummyObject())
nonisolated(unsafe) var numberOfNameCoalescingCalls = 0
let obs1 = NotificationCenter.default.addObserver(forName: notificationName, object: notification1.object, queue: nil) { notification in
numberOfNameCoalescingCalls += 1
}
let notification2 = Notification(name: notificationName, object: DummyObject())
nonisolated(unsafe) var numberOfObjectCoalescingCalls = 0
let obs2 = NotificationCenter.default.addObserver(forName: notificationName, object: notification2.object, queue: nil) { notification in
numberOfObjectCoalescingCalls += 1
}
let queue = NotificationQueue.default
// #1
queue.enqueue(notification1, postingStyle: .asap, coalesceMask: .onName, forModes: nil)
// #2
queue.enqueue(notification2, postingStyle: .asap, coalesceMask: .onSender, forModes: nil)
// #3, coalesce with 1 & 2
queue.enqueue(notification1, postingStyle: .asap, coalesceMask: .onName, forModes: nil)
// #4, coalesce with #3
queue.enqueue(notification2, postingStyle: .asap, coalesceMask: .onName, forModes: nil)
// #5
queue.enqueue(notification1, postingStyle: .asap, coalesceMask: .onSender, forModes: nil)
scheduleTimer(withInterval: 0.001)
// check that we received notifications #4 and #5
XCTAssertEqual(numberOfNameCoalescingCalls, 1)
XCTAssertEqual(numberOfObjectCoalescingCalls, 1)
NotificationCenter.default.removeObserver(obs1)
NotificationCenter.default.removeObserver(obs2)
}
func test_postIdleToDefaultQueue() {
let notificationName = Notification.Name(rawValue: "test_postIdleToDefaultQueue")
let dummyObject = DummyObject()
let notification = Notification(name: notificationName, object: dummyObject)
nonisolated(unsafe) var numberOfCalls = 0
let obs = NotificationCenter.default.addObserver(forName: notificationName, object: dummyObject, queue: nil) { notification in
numberOfCalls += 1
}
NotificationQueue.default.enqueue(notification, postingStyle: .whenIdle)
// add a timer to wakeup the runloop, process the timer and call the observer awaiting for any input sources/timers
scheduleTimer(withInterval: 0.001)
XCTAssertEqual(numberOfCalls, 1)
NotificationCenter.default.removeObserver(obs)
}
func test_notificationQueueLifecycle() {
// check that notificationqueue is associated with current thread. when the thread is destroyed, the queue should be deallocated as well
nonisolated(unsafe) weak var notificationQueue: NotificationQueue?
self.executeInBackgroundThread() {
let nq = NotificationQueue(notificationCenter: NotificationCenter())
notificationQueue = nq
XCTAssertNotNil(nq)
}
XCTAssertNil(notificationQueue)
}
// MARK: Private
private func scheduleTimer(withInterval interval: TimeInterval) {
let e = expectation(description: "Timer")
let dummyTimer = Timer.scheduledTimer(withTimeInterval: interval, repeats: false) { _ in
e.fulfill()
}
RunLoop.current.add(dummyTimer, forMode: .default)
waitForExpectations(timeout: 0.1)
}
private func executeInBackgroundThread(_ operation: @Sendable @escaping () -> Void) {
let e = expectation(description: "Background Execution")
let bgThread = Thread() {
operation()
e.fulfill()
}
bgThread.start()
waitForExpectations(timeout: 0.2)
// There is a small time gap between "e.fulfill()"
// and actuall thread termination.
// We need a little delay to allow bgThread actually die.
// Callers of this function are assuming thread is
// deallocated after call.
Thread.sleep(forTimeInterval: 0.05)
}
}
|
