-
Notifications
You must be signed in to change notification settings - Fork 0
/
RtcHooks.tsx
485 lines (417 loc) · 15.9 KB
/
RtcHooks.tsx
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
import { omit } from 'lodash';
import { createContext, PropsWithChildren, useCallback, useEffect, useRef, useState, useContext } from 'react';
import SimplePeer from 'simple-peer';
import { NetworkId } from '../api/RtcNetwork';
import cyrb53 from '../util/cyrb53';
import { callWith } from '../util/fp';
import tracked from '../util/trackedEventEmitter';
import { SocketInfo } from './useSocket';
/**
* Information about a remote user.
*/
export interface RemoteUserInfo {
/** An ID representing the connection. This is randomly generated and is not associated with the user's permanent ID */
id: string;
/** The display name of the user on the other side of the connection. */
displayName: string;
}
interface Peer extends SimplePeer.Instance, RemoteUserInfo {
isInitiator: boolean;
}
export type UsePeerCallback = (peer: Peer) => void | (() => void);
type RtcContextValue = (network: NetworkId) => {
callbacks: Set<UsePeerCallback>,
peers: Set<Peer>,
};
const RtcContext = createContext<RtcContextValue | undefined>(undefined);
export function RtcProvider({ socketInfo, children }: PropsWithChildren<{ socketInfo: SocketInfo }>) {
const onPeerCallbacksRef = useRef(new Map<NetworkId, Set<UsePeerCallback>>());
const peersRef = useRef(new Set<Peer>());
const getNetworkCallbacksRef = useRef((network: NetworkId) => {
let networkCallbacks = onPeerCallbacksRef.current.get(network);
if (!networkCallbacks) {
networkCallbacks = new Set();
onPeerCallbacksRef.current.set(network, networkCallbacks);
}
return {
callbacks: networkCallbacks,
peers: peersRef.current,
};
});
useEffect(() => {
if (!socketInfo) {
return;
}
const ws = tracked(socketInfo.socket);
function createPeerConnection(network: NetworkId, initiator: boolean, connectionId: string, info: { displayName: string } = { displayName: 'unknown' }) {
const peer = new SimplePeer({
initiator,
config: {
iceServers: socketInfo.iceServers,
},
}) as Peer;
peer.id = connectionId;
peer.displayName = info.displayName;
peer.isInitiator = initiator;
const cleanupCallbacks = [] as (() => void)[];
peersRef.current.add(peer);
console.debug('created peer', initiator, connectionId, info);
const peerTrackedWs = tracked(socketInfo.socket);
peer.on('error', err => console.error('peer error', err));
peer.on('signal', data => {
console.debug('signal to peer', connectionId);
ws.emit('provideWebRTCSignal', connectionId, data);
});
peerTrackedWs.on('signalWebRTCConnection', (conn, signal) => {
if (conn === connectionId) {
console.debug('recieved signal from peer', conn);
peer.signal(signal);
}
});
let intentionallyClosed = false;
peerTrackedWs.on('killWebRTCConnection', (conn) => {
if (conn === connectionId) {
console.debug('killed connection', conn);
intentionallyClosed = true;
peer.destroy();
}
});
peer.on('close', () => {
console.debug('closed', connectionId);
peerTrackedWs.offTracked();
cleanupCallbacks.forEach(callWith());
peersRef.current.delete(peer);
if (!intentionallyClosed) {
console.debug('attempting to revive', connectionId);
createPeerConnection(network, initiator, connectionId, info);
}
});
peer.once('connect', () => {
console.debug('connected', connectionId);
});
cleanupCallbacks.push(...[...getNetworkCallbacksRef.current(network).callbacks].map(cb => cb(peer) ?? (() => {})));
}
ws.on('createWebRTCConnection', createPeerConnection);
if (ws.connected) {
ws.emit('joinRtc');
}
ws.on('connect', () => ws.emit('joinRtc'));
return () => {
ws.offTracked();
};
}, [socketInfo]);
// Cleanup peers when leaving
useEffect(() => {
return () => {
// eslint-disable-next-line @grncdr/react-hooks/exhaustive-deps
for (const peer of peersRef.current) {
if (!peer.destroyed) {
peer.destroy();
}
}
};
}, []);
return <RtcContext.Provider value={getNetworkCallbacksRef.current}>{children}</RtcContext.Provider>;
}
function usePeer(network: NetworkId, callback: UsePeerCallback) {
const rtcData = useContext(RtcContext)?.(network);
useEffect(() => {
if (rtcData) {
rtcData.peers.forEach(callback);
}
// Fire onPeer callback for each peer on initial load
// eslint-disable-next-line @grncdr/react-hooks/exhaustive-deps
}, []);
useEffect(() => {
if (!rtcData) {
return;
}
if (rtcData.callbacks.has(callback)) {
console.error('Cannot use the same listener for multiple instances of usePeer.');
return;
}
rtcData.callbacks.add(callback);
return () => { rtcData.callbacks.delete(callback) };
}, [rtcData, callback]);
}
export const usePeer_unstable = usePeer;
function encode(id: bigint, data: Uint8Array) {
const buffer = new Uint8Array(data.length + 8);
const view = new DataView(buffer.buffer);
view.setBigUint64(0, id);
buffer.set(data, 8);
return buffer;
}
function decode(id: bigint, data: Uint8Array) {
const messageChannelId = new DataView(data.buffer).getBigUint64(0);
if (messageChannelId === id) {
return data.slice(8);
}
else {
console.debug(`recv message id ${messageChannelId} !== ${id}`);
}
}
function encodeString(id: bigint, str: string) {
console.debug(`encoding ${str} on channel ${id}`);
return encode(id, new TextEncoder().encode(str));
}
function decodeString(id: bigint, data: Uint8Array) {
const buffer = decode(id, data);
if (buffer) {
return new TextDecoder().decode(buffer);
}
}
export type DataChannelEmit<T> = (data: T, options?: {
/**
* A list of peer IDs to send the message to, or `'broadcast'` to send it to all peers.
* @default 'broadcast'
*/
target?: 'broadcast' | string[]
}) => void;
function useEmitFunction(channelId: bigint, getPeers: () => Iterable<Peer>): DataChannelEmit<Uint8Array> {
return useCallback((data, { target = 'broadcast' } = { }) => {
const encoded = encode(channelId, data);
for (const peer of target === 'broadcast' ? getPeers() : [...getPeers()].filter(x => target.includes(x.id))) {
if (peer.connected) {
peer.send(encoded);
}
else if (!peer.destroyed) {
peer.once('connect', () => peer.send(encoded));
}
}
}, [channelId, getPeers]);
}
type DataChannelLifecycle<T> = (
...args: [
event: 'connect',
data: {
/** Information about the user who connected */
who: RemoteUserInfo,
},
emit: DataChannelEmit<T>,
]
| [
event: 'message',
data: {
/** The data that was sent */
content: T,
/** Information about the user who sent the message */
from: RemoteUserInfo,
},
emit: DataChannelEmit<T>,
]
| [
event: 'disconnect',
data: {
/** Information about the user who disconnected */
who: RemoteUserInfo,
},
emit?: undefined,
]
) => void;
export function useDataChannelLifecycle(
network: NetworkId,
channelName: string,
handler: DataChannelLifecycle<Uint8Array>
): DataChannelEmit<Uint8Array> {
const channelId = cyrb53(channelName);
const emit = useEmitFunction(channelId, useCallback(() => peersRef.current, []));
const peersRef = useRef(new Set<Peer>());
const recvHandler = useCallback((peer: Peer, data: Uint8Array) => {
const decoded = decode(channelId, data);
if (decoded) {
handler('message', { content: decoded, from: peer }, emit);
}
}, [channelId, handler, emit]);
const peerRecvHandlerMap = useRef(new Map<Peer, (data: Uint8Array) => void>);
useEffect(() => {
for (const peer of peersRef.current) {
peer.off('data', peerRecvHandlerMap.current.get(peer)!);
const myRecvHandler = (data: Uint8Array) => recvHandler(peer, data);
peer.on('data', myRecvHandler);
peerRecvHandlerMap.current.set(peer, myRecvHandler);
}
}, [recvHandler]);
const disconnectHandlerRef = useRef<(peer: Peer) => void>(null!);
disconnectHandlerRef.current = peer => {
handler('disconnect', { who: peer });
};
usePeer(network, useCallback(peer => {
peersRef.current.add(peer);
const myRecvHandler = (data: Uint8Array) => recvHandler(peer, data);
peer.on('data', myRecvHandler);
peerRecvHandlerMap.current.set(peer, myRecvHandler);
handler('connect', { who: peer }, emit);
return () => {
peer.off('data', peerRecvHandlerMap.current.get(peer)!);
peerRecvHandlerMap.current.delete(peer);
peersRef.current.delete(peer);
disconnectHandlerRef.current(peer);
};
}, [handler, emit, recvHandler]));
return emit;
}
export function useDataChannel(
network: NetworkId,
channelName: string,
onData: (
/**
* The data received
*/
data: Uint8Array,
/**
* The peer that the data was sent by
*/
from: RemoteUserInfo
) => void,
): DataChannelEmit<Uint8Array> {
return useDataChannelLifecycle(network, channelName, useCallback((...[event, data]) => {
if (event === 'message') {
onData(data.content, data.from);
}
}, [onData]));
};
function convertEmitBytesToEmitString(emitBytes: DataChannelEmit<Uint8Array>): DataChannelEmit<string> {
return (data, options) => emitBytes(new TextEncoder().encode(data), options);
}
export function useStringDataChannelLifecycle(
network: NetworkId,
channelName: string,
handler: DataChannelLifecycle<string>
): DataChannelEmit<string> {
const emitBytes = useDataChannelLifecycle(network, channelName, useCallback((...[event, data, emit]) => {
switch (event) {
case 'connect':
return handler('connect', data, convertEmitBytesToEmitString(emit));
case 'message':
return handler('message', { content: new TextDecoder().decode(data.content), from: data.from }, convertEmitBytesToEmitString(emit));
case 'disconnect':
return handler(event, data);
}
}, [handler]));
return convertEmitBytesToEmitString(emitBytes);
}
export function useStringDataChannel(
network: NetworkId,
channelName: string,
onData: (
/**
* The data received
*/
data: string,
/**
* The peer that the data was sent by
*/
from: RemoteUserInfo
) => void,
): DataChannelEmit<string> {
return useStringDataChannelLifecycle(network, channelName, useCallback((...[event, data]) => {
if (event === 'message') {
onData(data.content, data.from);
}
}, [onData]));
};
export function useMediaChannel(
network: NetworkId,
channelName: string,
): readonly [readonly MediaStream[], (stream: MediaStream | undefined) => void] {
const channelId = cyrb53(channelName);
const peerIdIncRef = useRef(0);
const [incomingStreams, setIncomingStreams] = useState<{ [peerId: number]: MediaStream }>({});
const peersRef = useRef(new Set<Peer>());
const outgoingStreamRef = useRef<MediaStream | undefined>();
usePeer(network, useCallback(peer => {
peersRef.current.add(peer);
const peerId = peerIdIncRef.current++;
const streamMap = new Map<string, MediaStream>();
const streamHandler = (stream: MediaStream) => {
console.debug('stream arrived', stream.id);
streamMap.set(stream.id, stream);
};
const dataHandler = (data: Uint8Array) => {
if (peer.isInitiator) {
return;
}
const streamId = decodeString(channelId, data);
if (streamId) {
const stream = streamMap.get(streamId);
if (stream) {
console.debug('Stream had already arrived');
setIncomingStreams(streams => ({ ...streams, [peerId]: stream }));
}
else {
// If the stream arrives after the message about it, we'll just poll for a bit until it either arrives or times out
console.debug('Stream arrived after message');
(async () => {
for (let i = 0; i < 20; i++) {
await new Promise(resolve => setTimeout(resolve, 200));
console.debug('Polling to see if message arrived...');
const stream = streamMap.get(streamId);
if (stream) {
console.debug('Recieved stream from peer', peerId);
setIncomingStreams(streams => ({ ...streams, [peerId]: stream }));
return;
}
}
console.debug('Message about stream timed out.');
})();
}
}
else {
console.debug('cleared incoming stream');
setIncomingStreams(streams => omit(streams, peerId));
}
};
function handleConnect() {
if (outgoingStreamRef.current && peer.isInitiator) {
const encoded = encodeString(channelId, outgoingStreamRef.current?.id ?? '');
peer.addStream(outgoingStreamRef.current);
peer.send(encoded);
console.debug('sent!');
}
}
peer.on('stream', streamHandler);
peer.on('data', dataHandler);
if (peer.connected) {
handleConnect();
}
else {
peer.on('connect', handleConnect);
}
console.debug('established peer', peerId);
return () => {
console.debug('disconnected from peer', peerId);
peer.off('stream', streamHandler);
peer.off('data', dataHandler);
peersRef.current.delete(peer);
setIncomingStreams(streams => omit(streams, peerId));
};
}, [channelId]));
const currentStreamRef = useRef<MediaStream>();
console.debug(channelId, Object.values(incomingStreams));
return [
Object.values(incomingStreams),
useCallback(stream => {
outgoingStreamRef.current = stream;
const encoded = encodeString(channelId, stream?.id ?? '');
for (const peer of peersRef.current) {
if (!peer.isInitiator) {
return;
}
if (currentStreamRef.current) {
if (peer.streams.includes(currentStreamRef.current)) {
peer.removeStream(currentStreamRef.current);
}
}
if (peer.connected) {
if (stream) {
peer.addStream(stream);
}
peer.send(encoded);
console.debug('sent!');
}
}
currentStreamRef.current = stream;
}, [channelId]),
];
};