paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 13:33:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

local echo: Make get_next_local_id() less aggressive.

Browse Source 
We now make it so that get_next_local_id() only returns up
to 5 local ids relative to any given max id.

For example, if your pointer is at message 999, we'd give out
999.01, 999.02, ..., 999.05.

We also avoid giving out the same local id twice.  This prevents
a bug where if you had aborted a previously failed locally echoed
message, a subsequent local echo would get into a funny state.

In order to to prevent false alarms on using the same local id
twice, we call get_next_local_id() later in the try_deliver_locally()
function.
This commit is contained in:
Steve Howell
2017-07-17 16:25:25 -04:00
committed by Tim Abbott
parent 92ad988144
commit 1fd38e7e26
1 changed files with 44 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
static/js/echo.js
View File

@@ -35,15 +35,43 @@ function truncate_precision(float) {
return parseFloat(float.toFixed(3));
}
function get_next_local_id() {
var local_id_increment = 0.01;
var latest = page_params.max_message_id;
if (typeof message_list.all !== 'undefined' && message_list.all.last() !== undefined) {
latest = message_list.all.last().id;
}
latest = Math.max(0, latest);
return truncate_precision(latest + local_id_increment);
}
var get_next_local_id = (function () {
var already_used = {};
return function () {
var local_id_increment = 0.01;
var latest = page_params.max_message_id;
if (typeof message_list.all !== 'undefined' && message_list.all.last() !== undefined) {
latest = message_list.all.last().id;
}
latest = Math.max(0, latest);
var next_local_id = truncate_precision(latest + local_id_increment);
if (already_used[next_local_id]) {
// If our id is already used, it is probably an edge case like we had
// to abort a very recent message.
blueslip.warn("We don't reuse ids for local echo.");
return undefined;
}
if (next_local_id % 1 > local_id_increment * 5) {
blueslip.warn("Turning off local echo for this message to let host catch up");
return undefined;
}
if (next_local_id % 1 === 0) {
// The logic to stop at 0.05 should prevent us from ever wrapping around
// to the next integer.
blueslip.error("Programming error");
return undefined;
}
already_used[next_local_id] = true;
return next_local_id;
};
}());
function insert_local_message(message_request, local_id) {
// Shallow clone of message request object that is turned into something suitable
@@ -102,12 +130,6 @@ function insert_local_message(message_request, local_id) {
}
exports.try_deliver_locally = function try_deliver_locally(message_request) {
var next_local_id = get_next_local_id();
if (next_local_id % 1 === 0) {
blueslip.error("Incremented local id to next integer---100 local messages queued");
return undefined;
}
if (markdown.contains_bugdown(message_request.content)) {
return undefined;
}
@@ -116,6 +138,13 @@ exports.try_deliver_locally = function try_deliver_locally(message_request) {
return undefined;
}
var next_local_id = get_next_local_id();
if (!next_local_id) {
// This can happen for legit reasons.
return undefined;
}
return insert_local_message(message_request, next_local_id);
};