Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Multiple collections share sockets and peers when replicationWebrtc is used for synchronization #5926

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Multiple collections share sockets and peers when replicationWebrtc is used for synchronization #5926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
59b670e
ADD replication-webrtc support shared socket and shared peer
croatialu Apr 22, 2024
18ed1f9
FIX Differentiate collection name
croatialu Apr 22, 2024
abe2048
FIX only process data from same collection
croatialu Apr 23, 2024
339021a
FIX clear socket cache when destroy
croatialu Apr 23, 2024
6927db5
FIX type error of unit test
croatialu Apr 23, 2024
48ea5ee
FIX Modify the sockets definition location
croatialu Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
253 changes: 131 additions & 122 deletions src/plugins/replication-webrtc/connection-handler-simple-peer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,15 @@ export const SIMPLE_PEER_PING_INTERVAL = 1000 * 60 * 2;
* Returns a connection handler that uses simple-peer and the signaling server.
*/
export function getConnectionHandlerSimplePeer({
signalingServerUrl,
signalingServerUrl: signalingServerUrlInput,
wrtc,
config,
webSocketConstructor
webSocketConstructor: webSocketConstructorInput
}: SimplePeerConnectionHandlerOptions): WebRTCConnectionHandlerCreator<SimplePeer> {
ensureProcessNextTickIsSet();

signalingServerUrl = signalingServerUrl ? signalingServerUrl : DEFAULT_SIGNALING_SERVER;
webSocketConstructor = webSocketConstructor ? webSocketConstructor as any : WebSocket;
const signalingServerUrl = signalingServerUrlInput || DEFAULT_SIGNALING_SERVER;
const webSocketConstructor = (webSocketConstructorInput || WebSocket) as typeof WebSocket;

if (
signalingServerUrl.includes(DEFAULT_SIGNALING_SERVER_HOSTNAME) &&
Expand All @@ -123,20 +123,134 @@ export function getConnectionHandlerSimplePeer({
].join(' ')
);
}
const connect$ = new Subject<SimplePeer>();
const disconnect$ = new Subject<SimplePeer>();
const message$ = new Subject<PeerWithMessage<SimplePeer>>();
const response$ = new Subject<PeerWithResponse<SimplePeer>>();
const error$ = new Subject<RxError | RxTypeError>();

const creator: WebRTCConnectionHandlerCreator<SimplePeer> = async (options: SyncOptionsWebRTC<any, SimplePeer>) => {
const sockets = new Map<string, WebSocket>();
const peers = new Map<string, SimplePeer>();
let closed = false;
let ownPeerId: string;

/**
* @recursive calls it self on socket disconnects
* so that when the user goes offline and online
* again, it will recreate the WebSocket connection.
*/
function createSocket(roomName: string) {
if (closed) {
return;
}

const cachedSocket = sockets.get(signalingServerUrl);

if(cachedSocket) return cachedSocket

const socket = new webSocketConstructor(signalingServerUrl);
sockets.set(signalingServerUrl, socket);
socket.onclose = () => createSocket(roomName);
socket.onopen = () => {
ensureNotFalsy(socket).onmessage = (msgEvent: any) => {
const msg: PeerMessage = JSON.parse(msgEvent.data as any);
switch (msg.type) {
case 'init':
ownPeerId = msg.yourPeerId;
sendMessage(ensureNotFalsy(socket), {
type: 'join',
room: roomName
});
break;
case 'joined':
/**
* PeerId is created by the signaling server
* to prevent spoofing it.
*/
function createPeerConnection(remotePeerId: string) {
let disconnected = false;
const newSimplePeer: SimplePeer = new Peer({
initiator: remotePeerId > ownPeerId,
wrtc,
config,
trickle: true
}) as any;
newSimplePeer.id = randomCouchString(10);
peers.set(remotePeerId, newSimplePeer);


newSimplePeer.on('signal', (signal: any) => {
sendMessage(ensureNotFalsy(socket), {
type: 'signal',
senderPeerId: ownPeerId,
receiverPeerId: remotePeerId,
room: roomName,
data: signal
});
});

newSimplePeer.on('data', (messageOrResponse: any) => {
messageOrResponse = JSON.parse(messageOrResponse.toString());
if (messageOrResponse.result) {
response$.next({
peer: newSimplePeer,
response: messageOrResponse
});
} else {
message$.next({
peer: newSimplePeer,
message: messageOrResponse
});
}
});

const connect$ = new Subject<SimplePeer>();
const disconnect$ = new Subject<SimplePeer>();
const message$ = new Subject<PeerWithMessage<SimplePeer>>();
const response$ = new Subject<PeerWithResponse<SimplePeer>>();
const error$ = new Subject<RxError | RxTypeError>();
newSimplePeer.on('error', (error) => {
error$.next(newRxError('RC_WEBRTC_PEER', {
error
}));
newSimplePeer.destroy();
if (!disconnected) {
disconnected = true;
disconnect$.next(newSimplePeer);
}
});

newSimplePeer.on('connect', () => {
connect$.next(newSimplePeer);
});

newSimplePeer.on('close', () => {
if (!disconnected) {
disconnected = true;
disconnect$.next(newSimplePeer);
}
createPeerConnection(remotePeerId);
});
}
msg.otherPeerIds.forEach(remotePeerId => {
if (
remotePeerId === ownPeerId ||
peers.has(remotePeerId)
) {
return;
} else {
createPeerConnection(remotePeerId);
}

const peers = new Map<string, SimplePeer>();
let closed = false;
let ownPeerId: string;
let socket: WebSocket | undefined = undefined;
createSocket();
});
break;
case 'signal':
const peer = getFromMapOrThrow(peers, msg.senderPeerId);
peer.signal(msg.data);
break;
}
}
}
return socket
};

const creator: WebRTCConnectionHandlerCreator<SimplePeer> = async (options: SyncOptionsWebRTC<any, SimplePeer>) => {
let socket: WebSocket | undefined = createSocket(options.topic);


/**
Expand All @@ -155,113 +269,7 @@ export function getConnectionHandlerSimplePeer({
})();


/**
* @recursive calls it self on socket disconnects
* so that when the user goes offline and online
* again, it will recreate the WebSocket connection.
*/
function createSocket() {
if (closed) {
return;
}
socket = new (webSocketConstructor as any)(signalingServerUrl) as WebSocket;
socket.onclose = () => createSocket();
socket.onopen = () => {
ensureNotFalsy(socket).onmessage = (msgEvent: any) => {
const msg: PeerMessage = JSON.parse(msgEvent.data as any);
switch (msg.type) {
case 'init':
ownPeerId = msg.yourPeerId;
sendMessage(ensureNotFalsy(socket), {
type: 'join',
room: options.topic
});
break;
case 'joined':
/**
* PeerId is created by the signaling server
* to prevent spoofing it.
*/
function createPeerConnection(remotePeerId: string) {
let disconnected = false;
const newSimplePeer: SimplePeer = new Peer({
initiator: remotePeerId > ownPeerId,
wrtc,
config,
trickle: true
}) as any;
newSimplePeer.id = randomCouchString(10);
peers.set(remotePeerId, newSimplePeer);


newSimplePeer.on('signal', (signal: any) => {
sendMessage(ensureNotFalsy(socket), {
type: 'signal',
senderPeerId: ownPeerId,
receiverPeerId: remotePeerId,
room: options.topic,
data: signal
});
});

newSimplePeer.on('data', (messageOrResponse: any) => {
messageOrResponse = JSON.parse(messageOrResponse.toString());
if (messageOrResponse.result) {
response$.next({
peer: newSimplePeer,
response: messageOrResponse
});
} else {
message$.next({
peer: newSimplePeer,
message: messageOrResponse
});
}
});

newSimplePeer.on('error', (error) => {
error$.next(newRxError('RC_WEBRTC_PEER', {
error
}));
newSimplePeer.destroy();
if (!disconnected) {
disconnected = true;
disconnect$.next(newSimplePeer);
}
});

newSimplePeer.on('connect', () => {
connect$.next(newSimplePeer);
});

newSimplePeer.on('close', () => {
if (!disconnected) {
disconnected = true;
disconnect$.next(newSimplePeer);
}
createPeerConnection(remotePeerId);
});
}
msg.otherPeerIds.forEach(remotePeerId => {
if (
remotePeerId === ownPeerId ||
peers.has(remotePeerId)
) {
return;
} else {
createPeerConnection(remotePeerId);
}

});
break;
case 'signal':
const peer = getFromMapOrThrow(peers, msg.senderPeerId);
peer.signal(msg.data);
break;
}
}
}
};


const handler: WebRTCConnectionHandler<SimplePeer> = {
error$,
Expand All @@ -275,6 +283,7 @@ export function getConnectionHandlerSimplePeer({
destroy() {
closed = true;
ensureNotFalsy(socket).close();
sockets.delete(signalingServerUrl);
error$.complete();
connect$.complete();
disconnect$.complete();
Expand Down
38 changes: 25 additions & 13 deletions src/plugins/replication-webrtc/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ import type {
WebRTCReplicationCheckpoint,
WebRTCResponse,
RxWebRTCReplicationState,
SyncOptionsWebRTC
SyncOptionsWebRTC,
WebRTCMessage
} from './webrtc-types.ts';
import { newRxError } from '../../rx-error.ts';

Expand Down Expand Up @@ -89,7 +90,8 @@ export async function replicateWebRTC<RxDocType, PeerType>(
).subscribe(data => {
pool.connectionHandler.send(data.peer, {
id: data.message.id,
result: storageToken
result: storageToken,
collectionName: collection.name
});
})
);
Expand All @@ -114,7 +116,8 @@ export async function replicateWebRTC<RxDocType, PeerType>(
{
id: getRequestId(),
method: 'token',
params: []
params: [],
collectionName: collection.name
}
);
peerToken = tokenResponse.result;
Expand All @@ -136,7 +139,8 @@ export async function replicateWebRTC<RxDocType, PeerType>(
const masterChangeStreamSub = masterHandler.masterChangeStream$.subscribe(ev => {
const streamResponse: WebRTCResponse = {
id: 'masterChangeStream$',
result: ev
result: ev,
collectionName: collection.name
};
pool.connectionHandler.send(peer, streamResponse);
});
Expand All @@ -152,19 +156,23 @@ export async function replicateWebRTC<RxDocType, PeerType>(
const messageSub = pool.connectionHandler.message$
.pipe(
filter(data => data.peer === peer),
filter(data => data.message.method !== 'token')
filter(data => data.message.method !== 'token'),
filter(data => data.message.collectionName === collection.name),
)
.subscribe(async (data) => {
const { peer: msgPeer, message } = data;
/**
* If it is not a function,
* it means that the client requested the masterChangeStream$
*/
const method = (masterHandler as any)[message.method].bind(masterHandler);
const methodType = message.method as Exclude<WebRTCMessage['method'], 'token' | 'masterChangeStream$'>;

const method = masterHandler[methodType].bind(masterHandler);
const result = await (method as any)(...message.params);
const response: WebRTCResponse = {
id: message.id,
result
result,
collectionName: collection.name
};
pool.connectionHandler.send(msgPeer, response);
});
Expand All @@ -179,6 +187,11 @@ export async function replicateWebRTC<RxDocType, PeerType>(
retryTime: options.retryTime,
waitForLeadership: false,
pull: options.pull ? Object.assign({}, options.pull, {
stream$: pool.connectionHandler.response$.pipe(
filter(m => m.response.id === 'masterChangeStream$'),
filter(m => m.response.collectionName === collection.name),
map(m => m.response.result)
),
async handler(lastPulledCheckpoint: WebRTCReplicationCheckpoint | undefined) {
const answer = await sendMessageAndAwaitAnswer(
pool.connectionHandler,
Expand All @@ -189,15 +202,13 @@ export async function replicateWebRTC<RxDocType, PeerType>(
lastPulledCheckpoint,
ensureNotFalsy(options.pull).batchSize
],
id: getRequestId()
id: getRequestId(),
collectionName: collection.name
}
);

return answer.result;
},
stream$: pool.connectionHandler.response$.pipe(
filter(m => m.response.id === 'masterChangeStream$'),
map(m => m.response.result)
)

}) : undefined,
push: options.push ? Object.assign({}, options.push, {
Expand All @@ -208,7 +219,8 @@ export async function replicateWebRTC<RxDocType, PeerType>(
{
method: 'masterWrite',
params: [docs],
id: getRequestId()
id: getRequestId(),
collectionName: collection.name
}
);
return answer.result;
Expand Down