Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

typing_status: Refactor `state` object to either be null or has all 

fields set.

This commit refactors the `state` object to either be null or has all
the fields set at the same time because they are note really decoupled.

This helps us to clean our code a little bit as well as makes it easier
to migrate this module to TypeScript.
This commit is contained in:
Lalit 2023-05-31 22:32:24 +05:30 committed by Tim Abbott
parent d46279c41e
commit 3613404581
2 changed files with 23 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
web/shared/src/typing_status.js
View File

@ -1,4 +1,5 @@
import _ from "lodash";
import assert from "minimalistic-assert";
// The following constants are tuned to work with
// TYPING_STARTED_EXPIRY_PERIOD, which is what the other
@ -13,24 +14,14 @@ const TYPING_STARTED_WAIT_PERIOD = 10000; // 10s
const TYPING_STOPPED_WAIT_PERIOD = 5000; // 5s
/** Exported only for tests. */
export const state = {};
/** Exported only for tests. */
export function initialize_state() {
state.current_recipient = null;
state.next_send_start_time = undefined;
state.idle_timer = undefined;
}
initialize_state();
export let state = null;
/** Exported only for tests. */
export function stop_last_notification(worker) {
if (state.idle_timer) {
clearTimeout(state.idle_timer);
}
assert(state !== null, "State object should not be null here.");
clearTimeout(state.idle_timer);
worker.notify_server_stop(state.current_recipient);
initialize_state();
state = null;
}
/** Exported only for tests. */
@ -43,13 +34,14 @@ export function start_or_extend_idle_timer(worker) {
stop_last_notification(worker);
}
if (state.idle_timer) {
if (state?.idle_timer) {
clearTimeout(state.idle_timer);
}
state.idle_timer = setTimeout(on_idle_timeout, TYPING_STOPPED_WAIT_PERIOD);
return setTimeout(on_idle_timeout, TYPING_STOPPED_WAIT_PERIOD);
}
function set_next_start_time(current_time) {
assert(state !== null, "State object should not be null here.");
state.next_send_start_time = current_time + TYPING_STARTED_WAIT_PERIOD;
}
@ -60,6 +52,7 @@ function actually_ping_server(worker, recipient, current_time) {
/** Exported only for tests. */
export function maybe_ping_server(worker, recipient) {
assert(state !== null, "State object should not be null here.");
const current_time = worker.get_current_time();
if (current_time > state.next_send_start_time) {
actually_ping_server(worker, recipient, current_time);
@ -93,17 +86,16 @@ export function maybe_ping_server(worker, recipient) {
* anymore.
*/
export function update(worker, new_recipient) {
const current_recipient = state.current_recipient;
if (current_recipient !== null) {
if (state !== null) {
// We need to use _.isEqual for comparisons; === doesn't work
// on arrays.
if (_.isEqual(new_recipient, current_recipient)) {
if (_.isEqual(new_recipient, state.current_recipient)) {
// Nothing has really changed, except we may need
// to send a ping to the server.
maybe_ping_server(worker, new_recipient);
// We can also extend out our idle time.
start_or_extend_idle_timer(worker);
state.idle_timer = start_or_extend_idle_timer(worker);
return;
}
@ -122,8 +114,11 @@ export function update(worker, new_recipient) {
// We just started talking to this recipient, so notify
// the server.
state.current_recipient = new_recipient;
state = {
current_recipient: new_recipient,
next_send_start_time: 0,
idle_timer: start_or_extend_idle_timer(worker),
};
const current_time = worker.get_current_time();
actually_ping_server(worker, new_recipient, current_time);
start_or_extend_idle_timer(worker);
}

32
web/tests/typing_status.test.js
View File

@ -22,7 +22,7 @@ function returns_time(secs) {
}
run_test("basics", ({override, override_rewire}) => {
typing_status.initialize_state();
typing_status.state = null;
// invalid conversation basically does nothing
let worker = {};
@ -123,11 +123,7 @@ run_test("basics", ({override, override_rewire}) => {
const callback = events.idle_callback;
clear_events();
callback();
assert.deepEqual(typing_status.state, {
next_send_start_time: undefined,
idle_timer: undefined,
current_recipient: null,
});
assert.deepEqual(typing_status.state, null);
assert.deepEqual(events, {
idle_callback: undefined,
started: false,
@ -137,11 +133,7 @@ run_test("basics", ({override, override_rewire}) => {
// Call stop with nothing going on.
call_handler(null);
assert.deepEqual(typing_status.state, {
next_send_start_time: undefined,
idle_timer: undefined,
current_recipient: null,
});
assert.deepEqual(typing_status.state, null);
assert.deepEqual(events, {
idle_callback: undefined,
started: false,
@ -167,11 +159,7 @@ run_test("basics", ({override, override_rewire}) => {
// Explicitly stop alice.
call_handler(null);
assert.deepEqual(typing_status.state, {
next_send_start_time: undefined,
idle_timer: undefined,
current_recipient: null,
});
assert.deepEqual(typing_status.state, null);
assert.deepEqual(events, {
idle_callback: undefined,
started: false,
@ -197,11 +185,7 @@ run_test("basics", ({override, override_rewire}) => {
// Switch to an invalid conversation.
call_handler(null);
assert.deepEqual(typing_status.state, {
next_send_start_time: undefined,
idle_timer: undefined,
current_recipient: null,
});
assert.deepEqual(typing_status.state, null);
assert.deepEqual(events, {
idle_callback: undefined,
started: false,
@ -211,11 +195,7 @@ run_test("basics", ({override, override_rewire}) => {
// Switch to another invalid conversation.
call_handler(null);
assert.deepEqual(typing_status.state, {
next_send_start_time: undefined,
idle_timer: undefined,
current_recipient: null,
});
assert.deepEqual(typing_status.state, null);
assert.deepEqual(events, {
idle_callback: undefined,
started: false,