feat(tracker-assist): 3.4.3 data connetions map; buffering code split; optional logs

This commit is contained in:
ShiKhu 2021-10-04 22:32:28 +02:00
parent 0a0be4c43d
commit 00ae88b60f
4 changed files with 81 additions and 53 deletions

View file

@ -1,6 +1,6 @@
{
"name": "@openreplay/tracker-assist",
"version": "3.1.1",
"version": "3.4.3",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
@ -63,9 +63,9 @@
}
},
"@openreplay/tracker": {
"version": "3.3.0",
"resolved": "https://registry.npmjs.org/@openreplay/tracker/-/tracker-3.3.0.tgz",
"integrity": "sha512-g9sOG01VaiRLw4TcUbux8j3moa7gsGs8rjZPEVJ5SJqxjje9R7tpUD5UId9ne7QdHSoiHfrWFk3TNRLpXyvImg==",
"version": "3.4.4",
"resolved": "https://registry.npmjs.org/@openreplay/tracker/-/tracker-3.4.4.tgz",
"integrity": "sha512-IcuxwwTt1RtLZw9QlQVAVNqoybv0ZkD2ZDk2FeHEQ/+BItsMhG61/4/lB2yXKLTLr6ydeKTzwYvxfr1vwxn2dw==",
"dev": true,
"requires": {
"@medv/finder": "^2.0.0",

View file

@ -1,7 +1,7 @@
{
"name": "@openreplay/tracker-assist",
"description": "Tracker plugin for screen assistance through the WebRTC",
"version": "3.2.0",
"version": "3.4.3",
"keywords": [
"WebRTC",
"assistance",
@ -24,10 +24,10 @@
"peerjs": "^1.3.2"
},
"peerDependencies": {
"@openreplay/tracker": "^3.4.0"
"@openreplay/tracker": "^3.4.3"
},
"devDependencies": {
"@openreplay/tracker": "^3.4.0",
"@openreplay/tracker": "^3.4.3",
"prettier": "^1.18.2",
"replace-in-files-cli": "^1.0.0",
"typescript": "^3.6.4"

View file

@ -0,0 +1,36 @@
import type { DataConnection } from 'peerjs';
// TODO: proper Message type export from tracker in 3.5.0
interface Message {
encode(w: any): boolean;
}
// Bffering required in case of webRTC
export default class BufferingConnection {
private readonly buffer: Message[][] = []
private buffering: boolean = false
constructor(readonly conn: DataConnection){}
private sendNext() {
if (this.buffer.length) {
setTimeout(() => {
this.conn.send(this.buffer.shift())
this.sendNext()
}, 50)
} else {
this.buffering = false
}
}
send(messages: Message[]) {
if (!this.conn.open) { return; }
let i = 0;
while (i < messages.length) {
this.buffer.push(messages.slice(i, i+=1000))
}
if (!this.buffering) {
this.buffering = true
this.sendNext();
}
}
}

View file

@ -4,6 +4,7 @@ import type { DataConnection } from 'peerjs';
import { App, Messages } from '@openreplay/tracker';
import type Message from '@openreplay/tracker';
import BufferingConnection from './BufferingConnection';
import Mouse from './Mouse';
import CallWindow from './CallWindow';
import ConfirmWindow from './ConfirmWindow';
@ -31,14 +32,27 @@ export default function(opts: Partial<Options> = {}) {
},
opts,
);
return function(app: App | null, appOptions: { __DISABLE_SECURE_MODE?: boolean } = {}) {
return function(app: App | null, appOptions: { __debug_log?: boolean, __DISABLE_SECURE_MODE?: boolean } = {}) {
// @ts-ignore
if (app === null || !navigator?.mediaDevices?.getUserMedia) { // 93.04% browsers
return;
}
let assistDemandedRestart = false;
let peer : Peer | null = null;
function log(...args) {
// TODO: use warn/log from assist
appOptions.__debug_log && console.log("OpenReplay Assist. ", ...args)
}
function warn(...args) {
appOptions.__debug_log && console.warn("OpenReplay Assist. ", ...args)
}
let assistDemandedRestart = false
let peer : Peer | null = null
const openDataConnections: Record<string, BufferingConnection> = {}
app.addCommitCallback(function(messages) {
Object.values(openDataConnections).forEach(buffConn => buffConn.send(messages))
})
app.attachStopCallback(function() {
if (assistDemandedRestart) { return; }
@ -47,62 +61,40 @@ export default function(opts: Partial<Options> = {}) {
app.attachStartCallback(function() {
if (assistDemandedRestart) { return; }
const peerID = `${app.projectKey}-${app.getSessionID()}`
const peerID = `${app.getProjectKey()}-${app.getSessionID()}`
peer = new Peer(peerID, {
// @ts-ignore
host: app.getHost(),
path: '/assist',
port: location.protocol === 'http:' && appOptions.__DISABLE_SECURE_MODE ? 80 : 443,
});
console.log('OpenReplay tracker-assist peerID:', peerID)
peer.on('error', e => console.log("OpenReplay tracker-assist peer error: ", e.type, e))
peer.on('connection', function(conn) {
log('Peer created: ', peer)
peer.on('error', e => warn("Peer error: ", e.type, e))
peer.on('connection', function(conn) {
window.addEventListener("beforeunload", () => conn.open && conn.send("unload"));
log('Connecting...')
console.log('OpenReplay tracker-assist: Connecting...')
conn.on('open', function() {
console.log('OpenReplay tracker-assist: connection opened.')
// TODO: onClose
const buffer: Message[][] = [];
let buffering = false;
function sendNext() {
if (buffer.length) {
setTimeout(() => {
conn.send(buffer.shift());
sendNext();
}, 50);
} else {
buffering = false;
}
}
log('Connection opened.')
assistDemandedRestart = true;
app.stop();
//@ts-ignore (should update tracker dependency)
app.addCommitCallback((messages: Array<Message>): void => {
if (!conn.open) { return; } // TODO: clear commit callbacks on connection close
let i = 0;
while (i < messages.length) {
buffer.push(messages.slice(i, i+=1000));
}
if (!buffering) {
buffering = true;
sendNext();
}
});
app.start().then(() => { assistDemandedRestart = false; });
openDataConnections[conn.peer] = new BufferingConnection(conn)
conn.on('close', () => {
log("Connection close: ", conn.peer)
delete openDataConnections[conn.peer] // TODO: check if works properly
})
app.start().then(() => { assistDemandedRestart = false })
});
});
let callingState: CallingState = CallingState.False;
peer.on('call', function(call) {
log("Call: ", call)
if (!peer) { return; }
const dataConn: DataConnection | undefined = peer
.connections[call.peer].find(c => c.type === 'data');
if (callingState !== CallingState.False || !dataConn) {
const dataConn: DataConnection | undefined =
openDataConnections[call.peer]?.conn;
if (callingState !== CallingState.False || !dataConn || !dataConn.open) {
call.close();
return;
}
@ -131,7 +123,7 @@ export default function(opts: Partial<Options> = {}) {
confirmAnswer = confirm.mount();
dataConn.on('data', (data) => { // if call closed by a caller before confirm
if (data === "call_end") {
//console.log('OpenReplay tracker-assist: receiving callend onconfirm')
log("Recieved call_end during confirm opened")
setCallingState(CallingState.False);
confirm.remove();
}
@ -157,7 +149,7 @@ export default function(opts: Partial<Options> = {}) {
setCallingState(CallingState.False);
}
const initiateCallEnd = () => {
//console.log("callend initiated")
log("initiateCallEnd")
call.close()
notifyCallEnd();
onCallEnd();
@ -204,12 +196,12 @@ export default function(opts: Partial<Options> = {}) {
});
dataConn.on('data', (data: any) => {
if (data === "call_end") {
//console.log('receiving callend on call')
log('Recieved call_end during call')
onCallEnd();
return;
}
if (data && typeof data.name === 'string') {
//console.log("name",data)
log('Recieved name: ', data.name)
callUI.setAssistentName(data.name);
}
if (data && typeof data.x === 'number' && typeof data.y === 'number') {
@ -223,7 +215,7 @@ export default function(opts: Partial<Options> = {}) {
.catch(_ => { // TODO retry only if specific error
navigator.mediaDevices.getUserMedia({audio:true}) // in case there is no camera on device
.then(onCallConnect)
.catch(e => console.log("OpenReplay tracker-assist: cant reach media devices. ", e));
.catch(e => warn("Can't reach media devices. ", e));
});
}).catch(); // in case of Confirm.remove() without any confirmation
});