storm/skald
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplify the protocol and the protocol interface.

Browse Source 
Split the id field into id and source, where source indicates the sender
of the message and id the entity being sent.  Remove the label request,
just use the offerer's username.  Maintain the username within the
ServerConnection, this removes a parameter from some methods.
This commit is contained in:
Juliusz Chroboczek
2021-01-03 12:04:39 +01:00
parent 0563356180
commit f53276b89e
8 changed files with 118 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files
static/galene.js
+13 -30
View File
@@ -73,18 +73,6 @@ function getUserPass() {
return userpass || null;
}
/**
* Return null if the user hasn't logged in yet.
*
* @returns {string}
*/
function getUsername() {
let userpass = getUserPass();
if(!userpass)
return null;
return userpass.username;
}
/**
* @typedef {Object} settings
* @property {boolean} [localMute]
@@ -332,9 +320,6 @@ function gotDownStream(c) {
c.ondowntrack = function(track, transceiver, label, stream) {
setMedia(c, false);
}
c.onlabel = function(label) {
setLabel(c);
}
c.onstatus = function(status) {
setMediaStatus(c);
}
@@ -1324,7 +1309,7 @@ function setLabel(c, fallback) {
let label = document.getElementById('label-' + c.id);
if(!label)
return;
let l = c.label;
let l = c.username;
if(l) {
label.textContent = l;
label.classList.remove('label-fallback');
@@ -1856,7 +1841,7 @@ commands.clear = {
predicate: operatorPredicate,
description: 'clear the chat history',
f: (c, r) => {
serverConnection.groupAction(getUsername(), 'clearchat');
serverConnection.groupAction('clearchat');
}
};
@@ -1865,7 +1850,7 @@ commands.lock = {
description: 'lock this group',
parameters: '[message]',
f: (c, r) => {
serverConnection.groupAction(getUsername(), 'lock', r);
serverConnection.groupAction('lock', r);
}
};
@@ -1873,7 +1858,7 @@ commands.unlock = {
predicate: operatorPredicate,
description: 'unlock this group, revert the effect of /lock',
f: (c, r) => {
serverConnection.groupAction(getUsername(), 'unlock');
serverConnection.groupAction('unlock');
}
};
@@ -1881,7 +1866,7 @@ commands.record = {
predicate: recordingPredicate,
description: 'start recording',
f: (c, r) => {
serverConnection.groupAction(getUsername(), 'record');
serverConnection.groupAction('record');
}
};
@@ -1889,7 +1874,7 @@ commands.unrecord = {
predicate: recordingPredicate,
description: 'stop recording',
f: (c, r) => {
serverConnection.groupAction(getUsername(), 'unrecord');
serverConnection.groupAction('unrecord');
}
};
@@ -1897,7 +1882,7 @@ commands.subgroups = {
predicate: operatorPredicate,
description: 'list subgroups',
f: (c, r) => {
serverConnection.groupAction(getUsername(), 'subgroups');
serverConnection.groupAction('subgroups');
}
};
@@ -1969,9 +1954,8 @@ commands.msg = {
let id = findUserId(p[0]);
if(!id)
throw new Error(`Unknown user ${p[0]}`);
let username = getUsername();
serverConnection.chat(username, '', id, p[1]);
addToChatbox(serverConnection.id, id, username,
serverConnection.chat('', id, p[1]);
addToChatbox(serverConnection.id, id, serverConnection.username,
Date.now(), false, '', p[1]);
}
};
@@ -1987,7 +1971,7 @@ function userCommand(c, r) {
let id = findUserId(p[0]);
if(!id)
throw new Error(`Unknown user ${p[0]}`);
serverConnection.userAction(getUsername(), c, id, p[1]);
serverConnection.userAction(c, id, p[1]);
}
function userMessage(c, r) {
@@ -1997,7 +1981,7 @@ function userMessage(c, r) {
let id = findUserId(p[0]);
if(!id)
throw new Error(`Unknown user ${p[0]}`);
serverConnection.userMessage(getUsername(), c, id, p[1]);
serverConnection.userMessage(c, id, p[1]);
}
commands.kick = {
@@ -2058,7 +2042,7 @@ commands.wall = {
f: (c, r) => {
if(!r)
throw new Error('empty message');
serverConnection.userMessage(getUsername(), 'warning', '', r);
serverConnection.userMessage('warning', '', r);
},
};
@@ -2122,9 +2106,8 @@ function handleInput() {
return;
}
let username = getUsername();
try {
serverConnection.chat(username, me ? 'me' : '', '', message);
serverConnection.chat(me ? 'me' : '', '', message);
} catch(e) {
console.error(e);
displayError(e);
static/protocol.js
+42 -43
View File
@@ -59,11 +59,15 @@ function ServerConnection() {
*/
this.id = randomid();
/**
* The group that we have joined, or nil if we haven't joined yet.
* The group that we have joined, or null if we haven't joined yet.
*
* @type {string}
*/
this.group = null;
/**
* The username we joined as.
*/
this.username = null;
/**
* The underlying websocket.
*
@@ -171,6 +175,7 @@ function ServerConnection() {
* @property {string} type
* @property {string} [kind]
* @property {string} [id]
* @property {string} [source]
* @property {string} [dest]
* @property {string} [username]
* @property {string} [password]
@@ -248,6 +253,7 @@ ServerConnection.prototype.connect = async function(url) {
if(sc.group && sc.onjoined)
sc.onjoined.call(sc, 'leave', sc.group, {}, '');
sc.group = null;
sc.username = null;
if(sc.onclose)
sc.onclose.call(sc, e.code, e.reason);
reject(new Error('websocket close ' + e.code + ' ' + e.reason));
@@ -255,8 +261,11 @@ ServerConnection.prototype.connect = async function(url) {
this.socket.onmessage = function(e) {
let m = JSON.parse(e.data);
switch(m.type) {
case 'handshake':
break;
case 'offer':
sc.gotOffer(m.id, m.labels, m.offer, m.kind === 'renegotiate');
sc.gotOffer(m.id, m.labels, m.source, m.username,
m.offer, m.kind === 'renegotiate');
break;
case 'answer':
sc.gotAnswer(m.id, m.answer);
@@ -273,9 +282,6 @@ ServerConnection.prototype.connect = async function(url) {
case 'ice':
sc.gotRemoteIce(m.id, m.candidate);
break;
case 'label':
sc.gotLabel(m.id, m.value);
break;
case 'joined':
if(sc.group) {
if(m.group !== sc.group) {
@@ -284,6 +290,7 @@ ServerConnection.prototype.connect = async function(url) {
} else {
sc.group = m.group;
}
sc.username = m.username;
sc.permissions = m.permissions || [];
sc.rtcConfiguration = m.rtcConfiguration || null;
if(sc.onjoined)
@@ -298,14 +305,14 @@ ServerConnection.prototype.connect = async function(url) {
case 'chat':
if(sc.onchat)
sc.onchat.call(
sc, m.id, m.dest, m.username, m.time,
sc, m.source, m.dest, m.username, m.time,
m.privileged, m.kind, m.value,
);
break;
case 'usermessage':
if(sc.onusermessage)
sc.onusermessage.call(
sc, m.id, m.dest, m.username, m.time,
sc, m.source, m.dest, m.username, m.time,
m.privileged, m.kind, m.value,
);
break;
@@ -441,18 +448,17 @@ ServerConnection.prototype.newUpStream = function(id) {
* chat sends a chat message to the server. The server will normally echo
* the message back to the client.
*
* @param {string} username - The sender's username.
* @param {string} kind
* - The kind of message, either '', 'me' or an application-specific type.
* @param {string} dest - The id to send the message to, empty for broadcast.
* @param {string} value - The text of the message.
*/
ServerConnection.prototype.chat = function(username, kind, dest, value) {
ServerConnection.prototype.chat = function(kind, dest, value) {
this.send({
type: 'chat',
id: this.id,
source: this.id,
dest: dest,
username: username,
username: this.username,
kind: kind,
value: value,
});
@@ -461,17 +467,16 @@ ServerConnection.prototype.chat = function(username, kind, dest, value) {
/**
* userAction sends a request to act on a user.
*
* @param {string} username - The sender's username.
* @param {string} kind - One of "op", "unop", "kick", "present", "unpresent".
* @param {string} dest - The id of the user to act upon.
* @param {string} [value] - An optional user-readable message.
*/
ServerConnection.prototype.userAction = function(username, kind, dest, value) {
ServerConnection.prototype.userAction = function(kind, dest, value) {
this.send({
type: 'useraction',
id: this.id,
source: this.id,
dest: dest,
username: username,
username: this.username,
kind: kind,
value: value,
});
@@ -481,17 +486,16 @@ ServerConnection.prototype.userAction = function(username, kind, dest, value) {
* userMessage sends an application-specific message to a user.
* This is similar to a chat message, but is not saved in the chat history.
*
* @param {string} username - The sender's username.
* @param {string} kind - The kind of application-specific message.
* @param {string} dest - The id to send the message to, empty for broadcast.
* @param {string} [value] - An optional parameter.
*/
ServerConnection.prototype.userMessage = function(username, kind, dest, value) {
ServerConnection.prototype.userMessage = function(kind, dest, value) {
this.send({
type: 'usermessage',
id: this.id,
source: this.id,
dest: dest,
username: username,
username: this.username,
kind: kind,
value: value,
});
@@ -500,17 +504,16 @@ ServerConnection.prototype.userMessage = function(username, kind, dest, value) {
/**
* groupAction sends a request to act on the current group.
*
* @param {string} username - The sender's username.
* @param {string} kind
* - One of 'clearchat', 'lock', 'unlock', 'record' or 'unrecord'.
* @param {string} [message] - An optional user-readable message.
*/
ServerConnection.prototype.groupAction = function(username, kind, message) {
ServerConnection.prototype.groupAction = function(kind, message) {
this.send({
type: 'groupaction',
id: this.id,
source: this.id,
kind: kind,
username: username,
username: this.username,
value: message,
});
};
@@ -520,11 +523,13 @@ ServerConnection.prototype.groupAction = function(username, kind, message) {
*
* @param {string} id
* @param {Object<string, string>} labels
* @param {string} source
* @param {string} username
* @param {RTCSessionDescriptionInit} offer
* @param {boolean} renegotiate
* @function
*/
ServerConnection.prototype.gotOffer = async function(id, labels, offer, renegotiate) {
ServerConnection.prototype.gotOffer = async function(id, labels, source, username, offer, renegotiate) {
let sc = this;
let c = sc.down[id];
if(c && !renegotiate) {
@@ -586,6 +591,8 @@ ServerConnection.prototype.gotOffer = async function(id, labels, offer, renegoti
}
c.labelsByMid = labels;
c.source = source;
c.username = username;
if(sc.ondownstream)
sc.ondownstream.call(sc, c);
@@ -620,22 +627,6 @@ ServerConnection.prototype.gotOffer = async function(id, labels, offer, renegoti
c.onnegotiationcompleted.call(c);
};
/**
* Called when we receive a stream label from the server. Don't call this.
*
* @param {string} id
* @param {string} label
*/
ServerConnection.prototype.gotLabel = function(id, label) {
let c = this.down[id];
if(!c)
throw new Error('Got label for unknown id');
c.label = label;
if(c.onlabel)
c.onlabel.call(c, label);
};
/**
* Called when we receive an answer from the server. Don't call this.
*
@@ -765,13 +756,19 @@ function Stream(sc, id, pc, up) {
*/
this.kind = null;
/**
* For down streams, a user-readable label.
* For down streams, the id of the client that created the stream.
*
* @type {string}
*/
this.label = null;
this.source = null;
/**
* The associated RTCPeerConnectoin. This is null before the stream
* For down streams, the username of the client who created the stream.
*
* @type {string}
*/
this.username = null;
/**
* The associated RTCPeerConnection. This is null before the stream
* is connected, and may change over time.
*
* @type {RTCPeerConnection}
@@ -1036,6 +1033,8 @@ Stream.prototype.negotiate = async function (restartIce) {
c.sc.send({
type: 'offer',
source: c.sc.id,
username: c.sc.username,
kind: this.localDescriptionSent ? 'renegotiate' : '',
id: c.id,
labels: c.labelsByMid,