SignalClientTest.kt
17.0 KB
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
/*
* Copyright 2023 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.android.room
import io.livekit.android.BaseTest
import io.livekit.android.mock.MockWebSocketFactory
import io.livekit.android.mock.TestData
import io.livekit.android.stats.NetworkInfo
import io.livekit.android.stats.NetworkType
import io.livekit.android.util.toOkioByteString
import io.livekit.android.util.toPBByteString
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.async
import kotlinx.serialization.json.Json
import livekit.LivekitModels
import livekit.LivekitModels.ClientConfiguration
import livekit.LivekitRtc
import livekit.LivekitRtc.ICEServer
import okhttp3.*
import org.junit.Assert.*
import org.junit.Before
import org.junit.Test
import org.mockito.Mock
import org.mockito.Mockito
import org.mockito.kotlin.any
import org.mockito.kotlin.argThat
import org.mockito.kotlin.inOrder
import org.mockito.kotlin.times
import org.webrtc.SessionDescription
@ExperimentalCoroutinesApi
class SignalClientTest : BaseTest() {
lateinit var wsFactory: MockWebSocketFactory
lateinit var client: SignalClient
@Mock
lateinit var listener: SignalClient.Listener
@Mock
lateinit var okHttpClient: OkHttpClient
@Before
fun setup() {
wsFactory = MockWebSocketFactory()
client = SignalClient(
wsFactory,
Json,
okHttpClient = okHttpClient,
ioDispatcher = coroutineRule.dispatcher,
networkInfo = object : NetworkInfo {
override fun getNetworkType() = NetworkType.WIFI
},
)
client.listener = listener
}
private fun createOpenResponse(request: Request): Response {
return Response.Builder()
.request(request)
.code(200)
.protocol(Protocol.HTTP_2)
.message("")
.build()
}
/**
* Supply the needed websocket messages to finish a join call.
*/
private fun connectWebsocketAndJoin() {
client.onOpen(wsFactory.ws, createOpenResponse(wsFactory.request))
client.onMessage(wsFactory.ws, JOIN.toOkioByteString())
}
@Test
fun joinAndResponse() = runTest {
val job = async {
client.join(EXAMPLE_URL, "")
}
connectWebsocketAndJoin()
val response = job.await()
assertEquals(true, client.isConnected)
assertEquals(response, JOIN.join)
}
@Test
fun reconnect() = runTest {
val job = async {
client.reconnect(EXAMPLE_URL, "", "participant_sid")
}
client.onOpen(wsFactory.ws, createOpenResponse(wsFactory.request))
client.onMessage(wsFactory.ws, RECONNECT.toOkioByteString())
job.await()
assertEquals(true, client.isConnected)
}
@Test
fun joinFailure() = runTest {
var failed = false
val job = async {
try {
client.join(EXAMPLE_URL, "")
} catch (e: Exception) {
failed = true
}
}
client.onFailure(wsFactory.ws, Exception(), null)
job.await()
assertTrue(failed)
}
@Test
fun listenerNotCalledUntilOnReady() = runTest {
val job = async {
client.join(EXAMPLE_URL, "")
}
connectWebsocketAndJoin()
client.onMessage(wsFactory.ws, OFFER.toOkioByteString())
job.await()
Mockito.verifyNoInteractions(listener)
}
@Test
fun listenerCalledAfterOnReady() = runTest {
val job = async {
client.join(EXAMPLE_URL, "")
}
connectWebsocketAndJoin()
client.onMessage(wsFactory.ws, OFFER.toOkioByteString())
job.await()
client.onReadyForResponses()
Mockito.verify(listener)
.onOffer(argThat { type == SessionDescription.Type.OFFER && description == OFFER.offer.sdp })
}
/**
* [WebSocketListener.onFailure] does not call through to
* [WebSocketListener.onClosed]. Ensure that listener is called properly.
*/
@Test
fun listenerNotifiedAfterFailure() = runTest {
val job = async {
client.join(EXAMPLE_URL, "")
}
connectWebsocketAndJoin()
job.await()
client.onFailure(wsFactory.ws, Exception(), null)
Mockito.verify(listener)
.onClose(any(), any())
}
/**
* Ensure responses that come in before [SignalClient.onReadyForResponses] are queued.
*/
@Test
fun queuedResponses() = runTest {
val inOrder = inOrder(listener)
val job = async {
client.join(EXAMPLE_URL, "")
}
connectWebsocketAndJoin()
job.await()
client.onMessage(wsFactory.ws, OFFER.toOkioByteString())
client.onMessage(wsFactory.ws, ROOM_UPDATE.toOkioByteString())
client.onMessage(wsFactory.ws, ROOM_UPDATE.toOkioByteString())
client.onReadyForResponses()
inOrder.verify(listener).onOffer(any())
inOrder.verify(listener, times(2)).onRoomUpdate(any())
}
@Test
fun sendRequest() = runTest {
val job = async { client.join(EXAMPLE_URL, "") }
connectWebsocketAndJoin()
job.await()
client.sendMuteTrack("sid", true)
val ws = wsFactory.ws
assertEquals(1, ws.sentRequests.size)
val sentRequest = LivekitRtc.SignalRequest.newBuilder()
.mergeFrom(ws.sentRequests[0].toPBByteString())
.build()
assertTrue(sentRequest.hasMute())
}
@Test
fun queuedRequests() = runTest {
client.sendMuteTrack("sid", true)
client.sendMuteTrack("sid", true)
client.sendMuteTrack("sid", true)
val job = async { client.join(EXAMPLE_URL, "") }
connectWebsocketAndJoin()
job.await()
val ws = wsFactory.ws
assertEquals(3, ws.sentRequests.size)
val sentRequest = LivekitRtc.SignalRequest.newBuilder()
.mergeFrom(ws.sentRequests[0].toPBByteString())
.build()
assertTrue(sentRequest.hasMute())
}
@Test
fun queuedRequestsWhileReconnecting() = runTest {
client.sendMuteTrack("sid", true)
client.sendMuteTrack("sid", true)
client.sendMuteTrack("sid", true)
val job = async { client.reconnect(EXAMPLE_URL, "", "participant_sid") }
client.onOpen(wsFactory.ws, createOpenResponse(wsFactory.request))
client.onMessage(wsFactory.ws, RECONNECT.toOkioByteString())
job.await()
val ws = wsFactory.ws
// Wait until peer connection is connected to send requests.
assertEquals(0, ws.sentRequests.size)
client.onPCConnected()
assertEquals(3, ws.sentRequests.size)
val sentRequest = LivekitRtc.SignalRequest.newBuilder()
.mergeFrom(ws.sentRequests[0].toPBByteString())
.build()
assertTrue(sentRequest.hasMute())
}
@Test
fun pingTest() = runTest {
val joinResponseWithPing = with(JOIN.toBuilder()) {
join = with(join.toBuilder()) {
pingInterval = 10
pingTimeout = 20
build()
}
build()
}
val job = async {
client.join(EXAMPLE_URL, "")
}
client.onOpen(wsFactory.ws, createOpenResponse(wsFactory.request))
client.onMessage(wsFactory.ws, joinResponseWithPing.toOkioByteString())
job.await()
val originalWs = wsFactory.ws
assertFalse(originalWs.isClosed)
testScheduler.advanceTimeBy(15 * 1000)
assertTrue(
originalWs.sentRequests.any { requestString ->
val sentRequest = LivekitRtc.SignalRequest.newBuilder()
.mergeFrom(requestString.toPBByteString())
.build()
return@any sentRequest.hasPing()
},
)
client.onMessage(wsFactory.ws, PONG.toOkioByteString())
testScheduler.advanceTimeBy(10 * 1000)
assertFalse(originalWs.isClosed)
}
@Test
fun pingTimeoutTest() = runTest {
val joinResponseWithPing = with(JOIN.toBuilder()) {
join = with(join.toBuilder()) {
pingInterval = 10
pingTimeout = 20
build()
}
build()
}
val job = async {
client.join(EXAMPLE_URL, "")
}
client.onOpen(wsFactory.ws, createOpenResponse(wsFactory.request))
client.onMessage(wsFactory.ws, joinResponseWithPing.toOkioByteString())
job.await()
val originalWs = wsFactory.ws
assertFalse(originalWs.isClosed)
testScheduler.advanceUntilIdle()
assertTrue(originalWs.isClosed)
}
// mock data
companion object {
const val EXAMPLE_URL = "ws://www.example.com"
val JOIN = with(LivekitRtc.SignalResponse.newBuilder()) {
join = with(LivekitRtc.JoinResponse.newBuilder()) {
room = with(LivekitModels.Room.newBuilder()) {
name = "roomname"
sid = "room_sid"
build()
}
participant = TestData.LOCAL_PARTICIPANT
subscriberPrimary = true
addIceServers(
with(ICEServer.newBuilder()) {
addUrls("stun:stun.join.com:19302")
username = "username"
credential = "credential"
build()
},
)
serverVersion = "0.15.2"
build()
}
build()
}
val RECONNECT = with(LivekitRtc.SignalResponse.newBuilder()) {
reconnect = with(LivekitRtc.ReconnectResponse.newBuilder()) {
addIceServers(
with(ICEServer.newBuilder()) {
addUrls("stun:stun.reconnect.com:19302")
username = "username"
credential = "credential"
build()
},
)
clientConfiguration = with(ClientConfiguration.newBuilder()) {
forceRelay = LivekitModels.ClientConfigSetting.ENABLED
build()
}
build()
}
build()
}
val OFFER = with(LivekitRtc.SignalResponse.newBuilder()) {
offer = with(LivekitRtc.SessionDescription.newBuilder()) {
sdp = "remote_offer"
type = "offer"
build()
}
build()
}
val ROOM_UPDATE = with(LivekitRtc.SignalResponse.newBuilder()) {
roomUpdate = with(LivekitRtc.RoomUpdate.newBuilder()) {
room = with(LivekitModels.Room.newBuilder()) {
metadata = "metadata"
activeRecording = true
build()
}
build()
}
build()
}
val LOCAL_TRACK_PUBLISHED = with(LivekitRtc.SignalResponse.newBuilder()) {
trackPublished = with(LivekitRtc.TrackPublishedResponse.newBuilder()) {
cid = "local_cid"
track = TestData.LOCAL_AUDIO_TRACK
build()
}
build()
}
val LOCAL_TRACK_UNPUBLISHED = with(LivekitRtc.SignalResponse.newBuilder()) {
trackUnpublished = with(LivekitRtc.TrackUnpublishedResponse.newBuilder()) {
trackSid = TestData.LOCAL_AUDIO_TRACK.sid
build()
}
build()
}
val PERMISSION_CHANGE = with(LivekitRtc.SignalResponse.newBuilder()) {
update = with(LivekitRtc.ParticipantUpdate.newBuilder()) {
addParticipants(
TestData.LOCAL_PARTICIPANT.toBuilder()
.setPermission(
LivekitModels.ParticipantPermission.newBuilder()
.setCanPublish(false)
.setCanSubscribe(false)
.setCanPublishData(false)
.setHidden(false)
.setRecorder(false)
.build(),
)
.build(),
)
build()
}
build()
}
val PARTICIPANT_JOIN = with(LivekitRtc.SignalResponse.newBuilder()) {
update = with(LivekitRtc.ParticipantUpdate.newBuilder()) {
addParticipants(TestData.REMOTE_PARTICIPANT)
build()
}
build()
}
val PARTICIPANT_DISCONNECT = with(LivekitRtc.SignalResponse.newBuilder()) {
update = with(LivekitRtc.ParticipantUpdate.newBuilder()) {
val disconnectedParticipant = TestData.REMOTE_PARTICIPANT.toBuilder()
.setState(LivekitModels.ParticipantInfo.State.DISCONNECTED)
.build()
addParticipants(disconnectedParticipant)
build()
}
build()
}
val ACTIVE_SPEAKER_UPDATE = with(LivekitRtc.SignalResponse.newBuilder()) {
speakersChanged = with(LivekitRtc.SpeakersChanged.newBuilder()) {
addSpeakers(TestData.REMOTE_SPEAKER_INFO)
build()
}
build()
}
val LOCAL_PARTICIPANT_METADATA_CHANGED = with(LivekitRtc.SignalResponse.newBuilder()) {
update = with(LivekitRtc.ParticipantUpdate.newBuilder()) {
val participantMetadataChanged = TestData.LOCAL_PARTICIPANT.toBuilder()
.setMetadata("changed_metadata")
.setName("changed_name")
.build()
addParticipants(participantMetadataChanged)
build()
}
build()
}
val REMOTE_PARTICIPANT_METADATA_CHANGED = with(LivekitRtc.SignalResponse.newBuilder()) {
update = with(LivekitRtc.ParticipantUpdate.newBuilder()) {
val participantMetadataChanged = TestData.REMOTE_PARTICIPANT.toBuilder()
.setMetadata("changed_metadata")
.setName("changed_name")
.build()
addParticipants(participantMetadataChanged)
build()
}
build()
}
val CONNECTION_QUALITY = with(LivekitRtc.SignalResponse.newBuilder()) {
connectionQuality = with(LivekitRtc.ConnectionQualityUpdate.newBuilder()) {
addUpdates(
with(LivekitRtc.ConnectionQualityInfo.newBuilder()) {
participantSid = JOIN.join.participant.sid
quality = LivekitModels.ConnectionQuality.EXCELLENT
build()
},
)
build()
}
build()
}
val STREAM_STATE_UPDATE = with(LivekitRtc.SignalResponse.newBuilder()) {
streamStateUpdate = with(LivekitRtc.StreamStateUpdate.newBuilder()) {
addStreamStates(
with(LivekitRtc.StreamStateInfo.newBuilder()) {
participantSid = TestData.REMOTE_PARTICIPANT.sid
trackSid = TestData.REMOTE_AUDIO_TRACK.sid
state = LivekitRtc.StreamState.ACTIVE
build()
},
)
build()
}
build()
}
val SUBSCRIPTION_PERMISSION_UPDATE = with(LivekitRtc.SignalResponse.newBuilder()) {
subscriptionPermissionUpdate = with(LivekitRtc.SubscriptionPermissionUpdate.newBuilder()) {
participantSid = TestData.REMOTE_PARTICIPANT.sid
trackSid = TestData.REMOTE_AUDIO_TRACK.sid
allowed = false
build()
}
build()
}
val REFRESH_TOKEN = with(LivekitRtc.SignalResponse.newBuilder()) {
refreshToken = "refresh_token"
build()
}
val PONG = with(LivekitRtc.SignalResponse.newBuilder()) {
pong = 1L
build()
}
val LEAVE = with(LivekitRtc.SignalResponse.newBuilder()) {
leave = with(LivekitRtc.LeaveRequest.newBuilder()) {
reason = LivekitModels.DisconnectReason.SERVER_SHUTDOWN
build()
}
build()
}
}
}