503 lines
16 KiB
JavaScript
503 lines
16 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* This code is mostly from the old Etherpad. Please help us to comment this code.
|
|
* This helps other people to understand this code better and helps them to improve it.
|
|
* TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED
|
|
*/
|
|
|
|
/**
|
|
* Copyright 2009 Google 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.
|
|
*/
|
|
|
|
const chat = require('./chat').chat;
|
|
const hooks = require('./pluginfw/hooks');
|
|
const browser = require('./vendors/browser');
|
|
|
|
// Dependency fill on init. This exists for `pad.socket` only.
|
|
// TODO: bind directly to the socket.
|
|
let pad = undefined;
|
|
const getSocket = () => pad && pad.socket;
|
|
|
|
/** Call this when the document is ready, and a new Ace2Editor() has been created and inited.
|
|
ACE's ready callback does not need to have fired yet.
|
|
"serverVars" are from calling doc.getCollabClientVars() on the server. */
|
|
const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad) => {
|
|
const editor = ace2editor;
|
|
pad = _pad; // Inject pad to avoid a circular dependency.
|
|
|
|
let rev = serverVars.rev;
|
|
let committing = false;
|
|
let stateMessage;
|
|
let channelState = 'CONNECTING';
|
|
let lastCommitTime = 0;
|
|
let initialStartConnectTime = 0;
|
|
let commitDelay = 500;
|
|
|
|
const userId = initialUserInfo.userId;
|
|
// var socket;
|
|
const userSet = {}; // userId -> userInfo
|
|
userSet[userId] = initialUserInfo;
|
|
|
|
let isPendingRevision = false;
|
|
|
|
const callbacks = {
|
|
onUserJoin: () => {},
|
|
onUserLeave: () => {},
|
|
onUpdateUserInfo: () => {},
|
|
onChannelStateChange: () => {},
|
|
onClientMessage: () => {},
|
|
onInternalAction: () => {},
|
|
onConnectionTrouble: () => {},
|
|
onServerMessage: () => {},
|
|
};
|
|
if (browser.firefox) {
|
|
// Prevent "escape" from taking effect and canceling a comet connection;
|
|
// doesn't work if focus is on an iframe.
|
|
$(window).bind('keydown', (evt) => {
|
|
if (evt.which === 27) {
|
|
evt.preventDefault();
|
|
}
|
|
});
|
|
}
|
|
|
|
const handleUserChanges = () => {
|
|
if (editor.getInInternationalComposition()) {
|
|
// handleUserChanges() will be called again once composition ends so there's no need to set up
|
|
// a future call before returning.
|
|
return;
|
|
}
|
|
const now = Date.now();
|
|
if ((!getSocket()) || channelState === 'CONNECTING') {
|
|
if (channelState === 'CONNECTING' && (now - initialStartConnectTime) > 20000) {
|
|
setChannelState('DISCONNECTED', 'initsocketfail');
|
|
} else {
|
|
// check again in a bit
|
|
setTimeout(handleUserChanges, 1000);
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (committing) {
|
|
if (now - lastCommitTime > 20000) {
|
|
// a commit is taking too long
|
|
setChannelState('DISCONNECTED', 'slowcommit');
|
|
} else if (now - lastCommitTime > 5000) {
|
|
callbacks.onConnectionTrouble('SLOW');
|
|
} else {
|
|
// run again in a few seconds, to detect a disconnect
|
|
setTimeout(handleUserChanges, 3000);
|
|
}
|
|
return;
|
|
}
|
|
|
|
const earliestCommit = lastCommitTime + commitDelay;
|
|
if (now < earliestCommit) {
|
|
setTimeout(handleUserChanges, earliestCommit - now);
|
|
return;
|
|
}
|
|
|
|
let sentMessage = false;
|
|
// Check if there are any pending revisions to be received from server.
|
|
// Allow only if there are no pending revisions to be received from server
|
|
if (!isPendingRevision) {
|
|
const userChangesData = editor.prepareUserChangeset();
|
|
if (userChangesData.changeset) {
|
|
lastCommitTime = now;
|
|
committing = true;
|
|
stateMessage = {
|
|
type: 'USER_CHANGES',
|
|
baseRev: rev,
|
|
changeset: userChangesData.changeset,
|
|
apool: userChangesData.apool,
|
|
};
|
|
sendMessage(stateMessage);
|
|
sentMessage = true;
|
|
callbacks.onInternalAction('commitPerformed');
|
|
}
|
|
} else {
|
|
// run again in a few seconds, to check if there was a reconnection attempt
|
|
setTimeout(handleUserChanges, 3000);
|
|
}
|
|
|
|
if (sentMessage) {
|
|
// run again in a few seconds, to detect a disconnect
|
|
setTimeout(handleUserChanges, 3000);
|
|
}
|
|
};
|
|
|
|
const acceptCommit = () => {
|
|
editor.applyPreparedChangesetToBase();
|
|
setStateIdle();
|
|
try {
|
|
callbacks.onInternalAction('commitAcceptedByServer');
|
|
callbacks.onConnectionTrouble('OK');
|
|
} catch (err) { /* intentionally ignored */ }
|
|
handleUserChanges();
|
|
};
|
|
|
|
const setUpSocket = () => {
|
|
setChannelState('CONNECTED');
|
|
doDeferredActions();
|
|
|
|
initialStartConnectTime = Date.now();
|
|
};
|
|
|
|
const sendMessage = (msg) => {
|
|
getSocket().json.send(
|
|
{
|
|
type: 'COLLABROOM',
|
|
component: 'pad',
|
|
data: msg,
|
|
});
|
|
};
|
|
|
|
const serverMessageTaskQueue = new class {
|
|
constructor() {
|
|
this._promiseChain = Promise.resolve();
|
|
}
|
|
|
|
async enqueue(fn) {
|
|
const taskPromise = this._promiseChain.then(fn);
|
|
// Use .catch() to prevent rejections from halting the queue.
|
|
this._promiseChain = taskPromise.catch(() => {});
|
|
// Do NOT do `return await this._promiseChain;` because the caller would not see an error if
|
|
// fn() throws/rejects (due to the .catch() added above).
|
|
return await taskPromise;
|
|
}
|
|
}();
|
|
|
|
const handleMessageFromServer = (evt) => {
|
|
if (!getSocket()) return;
|
|
if (!evt.data) return;
|
|
const wrapper = evt;
|
|
if (wrapper.type !== 'COLLABROOM' && wrapper.type !== 'CUSTOM') return;
|
|
const msg = wrapper.data;
|
|
|
|
if (msg.type === 'NEW_CHANGES') {
|
|
serverMessageTaskQueue.enqueue(async () => {
|
|
// Avoid updating the DOM while the user is composing a character. Notes about this `await`:
|
|
// * `await null;` is equivalent to `await Promise.resolve(null);`, so if the user is not
|
|
// currently composing a character then execution will continue without error.
|
|
// * We assume that it is not possible for a new 'compositionstart' event to fire after
|
|
// the `await` but before the next line of code after the `await` (or, if it is
|
|
// possible, that the chances are so small or the consequences so minor that it's not
|
|
// worth addressing).
|
|
await editor.getInInternationalComposition();
|
|
const {newRev, changeset, author = '', apool} = msg;
|
|
if (newRev !== (rev + 1)) {
|
|
window.console.warn(`bad message revision on NEW_CHANGES: ${newRev} not ${rev + 1}`);
|
|
// setChannelState("DISCONNECTED", "badmessage_newchanges");
|
|
return;
|
|
}
|
|
rev = newRev;
|
|
editor.applyChangesToBase(changeset, author, apool);
|
|
});
|
|
} else if (msg.type === 'ACCEPT_COMMIT') {
|
|
serverMessageTaskQueue.enqueue(() => {
|
|
const {newRev} = msg;
|
|
// newRev will equal rev if the changeset has no net effect (identity changeset, removing
|
|
// and re-adding the same characters with the same attributes, or retransmission of an
|
|
// already applied changeset).
|
|
if (![rev, rev + 1].includes(newRev)) {
|
|
window.console.warn(`bad message revision on ACCEPT_COMMIT: ${newRev} not ${rev + 1}`);
|
|
// setChannelState("DISCONNECTED", "badmessage_acceptcommit");
|
|
return;
|
|
}
|
|
rev = newRev;
|
|
acceptCommit();
|
|
});
|
|
} else if (msg.type === 'CLIENT_RECONNECT') {
|
|
// Server sends a CLIENT_RECONNECT message when there is a client reconnect.
|
|
// Server also returns all pending revisions along with this CLIENT_RECONNECT message
|
|
serverMessageTaskQueue.enqueue(() => {
|
|
if (msg.noChanges) {
|
|
// If no revisions are pending, just make everything normal
|
|
setIsPendingRevision(false);
|
|
return;
|
|
}
|
|
const {headRev, newRev, changeset, author = '', apool} = msg;
|
|
if (newRev !== (rev + 1)) {
|
|
window.console.warn(`bad message revision on CLIENT_RECONNECT: ${newRev} not ${rev + 1}`);
|
|
// setChannelState("DISCONNECTED", "badmessage_acceptcommit");
|
|
return;
|
|
}
|
|
rev = newRev;
|
|
if (author === pad.getUserId()) {
|
|
acceptCommit();
|
|
} else {
|
|
editor.applyChangesToBase(changeset, author, apool);
|
|
}
|
|
if (newRev === headRev) {
|
|
// Once we have applied all pending revisions, make everything normal
|
|
setIsPendingRevision(false);
|
|
}
|
|
});
|
|
} else if (msg.type === 'USER_NEWINFO') {
|
|
const userInfo = msg.userInfo;
|
|
const id = userInfo.userId;
|
|
if (userSet[id]) {
|
|
userSet[id] = userInfo;
|
|
callbacks.onUpdateUserInfo(userInfo);
|
|
} else {
|
|
userSet[id] = userInfo;
|
|
callbacks.onUserJoin(userInfo);
|
|
}
|
|
tellAceActiveAuthorInfo(userInfo);
|
|
} else if (msg.type === 'USER_LEAVE') {
|
|
const userInfo = msg.userInfo;
|
|
const id = userInfo.userId;
|
|
if (userSet[id]) {
|
|
delete userSet[userInfo.userId];
|
|
fadeAceAuthorInfo(userInfo);
|
|
callbacks.onUserLeave(userInfo);
|
|
}
|
|
} else if (msg.type === 'CLIENT_MESSAGE') {
|
|
callbacks.onClientMessage(msg.payload);
|
|
} else if (msg.type === 'CHAT_MESSAGE') {
|
|
chat.addMessage(msg.message, true, false);
|
|
} else if (msg.type === 'CHAT_MESSAGES') {
|
|
for (let i = msg.messages.length - 1; i >= 0; i--) {
|
|
chat.addMessage(msg.messages[i], true, true);
|
|
}
|
|
if (!chat.gotInitalMessages) {
|
|
chat.scrollDown();
|
|
chat.gotInitalMessages = true;
|
|
chat.historyPointer = clientVars.chatHead - msg.messages.length;
|
|
}
|
|
|
|
// messages are loaded, so hide the loading-ball
|
|
$('#chatloadmessagesball').css('display', 'none');
|
|
|
|
// there are less than 100 messages or we reached the top
|
|
if (chat.historyPointer <= 0) {
|
|
$('#chatloadmessagesbutton').css('display', 'none');
|
|
} else {
|
|
// there are still more messages, re-show the load-button
|
|
$('#chatloadmessagesbutton').css('display', 'block');
|
|
}
|
|
}
|
|
|
|
// HACKISH: User messages do not have "payload" but "userInfo", so that all
|
|
// "handleClientMessage_USER_" hooks would work, populate payload
|
|
// FIXME: USER_* messages to have "payload" property instead of "userInfo",
|
|
// seems like a quite a big work
|
|
if (msg.type.indexOf('USER_') > -1) {
|
|
msg.payload = msg.userInfo;
|
|
}
|
|
// Similar for NEW_CHANGES
|
|
if (msg.type === 'NEW_CHANGES') msg.payload = msg;
|
|
|
|
hooks.callAll(`handleClientMessage_${msg.type}`, {payload: msg.payload});
|
|
};
|
|
|
|
const updateUserInfo = (userInfo) => {
|
|
userInfo.userId = userId;
|
|
userSet[userId] = userInfo;
|
|
tellAceActiveAuthorInfo(userInfo);
|
|
if (!getSocket()) return;
|
|
sendMessage(
|
|
{
|
|
type: 'USERINFO_UPDATE',
|
|
userInfo,
|
|
});
|
|
};
|
|
|
|
const tellAceActiveAuthorInfo = (userInfo) => {
|
|
tellAceAuthorInfo(userInfo.userId, userInfo.colorId);
|
|
};
|
|
|
|
const tellAceAuthorInfo = (userId, colorId, inactive) => {
|
|
if (typeof colorId === 'number') {
|
|
colorId = clientVars.colorPalette[colorId];
|
|
}
|
|
|
|
const cssColor = colorId;
|
|
if (inactive) {
|
|
editor.setAuthorInfo(userId, {
|
|
bgcolor: cssColor,
|
|
fade: 0.5,
|
|
});
|
|
} else {
|
|
editor.setAuthorInfo(userId, {
|
|
bgcolor: cssColor,
|
|
});
|
|
}
|
|
};
|
|
|
|
const fadeAceAuthorInfo = (userInfo) => {
|
|
tellAceAuthorInfo(userInfo.userId, userInfo.colorId, true);
|
|
};
|
|
|
|
const getConnectedUsers = () => valuesArray(userSet);
|
|
|
|
const tellAceAboutHistoricalAuthors = (hadata) => {
|
|
for (const [author, data] of Object.entries(hadata)) {
|
|
if (!userSet[author]) {
|
|
tellAceAuthorInfo(author, data.colorId, true);
|
|
}
|
|
}
|
|
};
|
|
|
|
const setChannelState = (newChannelState, moreInfo) => {
|
|
if (newChannelState !== channelState) {
|
|
channelState = newChannelState;
|
|
callbacks.onChannelStateChange(channelState, moreInfo);
|
|
}
|
|
};
|
|
|
|
const valuesArray = (obj) => {
|
|
const array = [];
|
|
$.each(obj, (k, v) => {
|
|
array.push(v);
|
|
});
|
|
return array;
|
|
};
|
|
|
|
// We need to present a working interface even before the socket
|
|
// is connected for the first time.
|
|
let deferredActions = [];
|
|
|
|
const defer = (func, tag) => function (...args) {
|
|
const action = () => {
|
|
func.call(this, ...args);
|
|
};
|
|
action.tag = tag;
|
|
if (channelState === 'CONNECTING') {
|
|
deferredActions.push(action);
|
|
} else {
|
|
action();
|
|
}
|
|
};
|
|
|
|
const doDeferredActions = (tag) => {
|
|
const newArray = [];
|
|
for (let i = 0; i < deferredActions.length; i++) {
|
|
const a = deferredActions[i];
|
|
if ((!tag) || (tag === a.tag)) {
|
|
a();
|
|
} else {
|
|
newArray.push(a);
|
|
}
|
|
}
|
|
deferredActions = newArray;
|
|
};
|
|
|
|
const sendClientMessage = (msg) => {
|
|
sendMessage(
|
|
{
|
|
type: 'CLIENT_MESSAGE',
|
|
payload: msg,
|
|
});
|
|
};
|
|
|
|
const getCurrentRevisionNumber = () => rev;
|
|
|
|
const getMissedChanges = () => {
|
|
const obj = {};
|
|
obj.userInfo = userSet[userId];
|
|
obj.baseRev = rev;
|
|
if (committing && stateMessage) {
|
|
obj.committedChangeset = stateMessage.changeset;
|
|
obj.committedChangesetAPool = stateMessage.apool;
|
|
editor.applyPreparedChangesetToBase();
|
|
}
|
|
const userChangesData = editor.prepareUserChangeset();
|
|
if (userChangesData.changeset) {
|
|
obj.furtherChangeset = userChangesData.changeset;
|
|
obj.furtherChangesetAPool = userChangesData.apool;
|
|
}
|
|
return obj;
|
|
};
|
|
|
|
const setStateIdle = () => {
|
|
committing = false;
|
|
callbacks.onInternalAction('newlyIdle');
|
|
schedulePerhapsCallIdleFuncs();
|
|
};
|
|
|
|
const setIsPendingRevision = (value) => {
|
|
isPendingRevision = value;
|
|
};
|
|
|
|
const idleFuncs = [];
|
|
|
|
const callWhenNotCommitting = (func) => {
|
|
idleFuncs.push(func);
|
|
schedulePerhapsCallIdleFuncs();
|
|
};
|
|
|
|
const schedulePerhapsCallIdleFuncs = () => {
|
|
setTimeout(() => {
|
|
if (!committing) {
|
|
while (idleFuncs.length > 0) {
|
|
const f = idleFuncs.shift();
|
|
f();
|
|
}
|
|
}
|
|
}, 0);
|
|
};
|
|
|
|
const self = {
|
|
setOnUserJoin: (cb) => {
|
|
callbacks.onUserJoin = cb;
|
|
},
|
|
setOnUserLeave: (cb) => {
|
|
callbacks.onUserLeave = cb;
|
|
},
|
|
setOnUpdateUserInfo: (cb) => {
|
|
callbacks.onUpdateUserInfo = cb;
|
|
},
|
|
setOnChannelStateChange: (cb) => {
|
|
callbacks.onChannelStateChange = cb;
|
|
},
|
|
setOnClientMessage: (cb) => {
|
|
callbacks.onClientMessage = cb;
|
|
},
|
|
setOnInternalAction: (cb) => {
|
|
callbacks.onInternalAction = cb;
|
|
},
|
|
setOnConnectionTrouble: (cb) => {
|
|
callbacks.onConnectionTrouble = cb;
|
|
},
|
|
updateUserInfo: defer(updateUserInfo),
|
|
handleMessageFromServer,
|
|
getConnectedUsers,
|
|
sendClientMessage,
|
|
sendMessage,
|
|
getCurrentRevisionNumber,
|
|
getMissedChanges,
|
|
callWhenNotCommitting,
|
|
addHistoricalAuthors: tellAceAboutHistoricalAuthors,
|
|
setChannelState,
|
|
setStateIdle,
|
|
setIsPendingRevision,
|
|
set commitDelay(ms) { commitDelay = ms; },
|
|
get commitDelay() { return commitDelay; },
|
|
};
|
|
|
|
tellAceAboutHistoricalAuthors(serverVars.historicalAuthorData);
|
|
tellAceActiveAuthorInfo(initialUserInfo);
|
|
|
|
editor.setProperty('userAuthor', userId);
|
|
editor.setBaseAttributedText(serverVars.initialAttributedText, serverVars.apool);
|
|
editor.setUserChangeNotificationCallback(handleUserChanges);
|
|
|
|
setUpSocket();
|
|
return self;
|
|
};
|
|
|
|
exports.getCollabClient = getCollabClient;
|