mirror of
https://github.com/zulip/zulip.git
synced 2025-11-22 07:21:23 +00:00
web: Move web app to ‘web’ directory.
Ever since we started bundling the app with webpack, there’s been less and less overlap between our ‘static’ directory (files belonging to the frontend app) and Django’s interpretation of the ‘static’ directory (files served directly to the web). Split the app out to its own ‘web’ directory outside of ‘static’, and remove all the custom collectstatic --ignore rules. This makes it much clearer what’s actually being served to the web, and what’s being bundled by webpack. It also shrinks the release tarball by 3%. Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
129
web/shared/src/typing_status.js
Normal file
129
web/shared/src/typing_status.js
Normal file
@@ -0,0 +1,129 @@
|
||||
import _ from "lodash";
|
||||
|
||||
// The following constants are tuned to work with
|
||||
// TYPING_STARTED_EXPIRY_PERIOD, which is what the other
|
||||
// users will use to time out our messages. (Or us,
|
||||
// depending on your perspective.) See typing_events.js.
|
||||
|
||||
// How frequently 'still typing' notifications are sent
|
||||
// to extend the expiry
|
||||
const TYPING_STARTED_WAIT_PERIOD = 10000; // 10s
|
||||
// How long after someone stops editing in the compose box
|
||||
// do we send a 'stopped typing' notification
|
||||
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();
|
||||
|
||||
/** Exported only for tests. */
|
||||
export function stop_last_notification(worker) {
|
||||
if (state.idle_timer) {
|
||||
clearTimeout(state.idle_timer);
|
||||
}
|
||||
worker.notify_server_stop(state.current_recipient);
|
||||
initialize_state();
|
||||
}
|
||||
|
||||
/** Exported only for tests. */
|
||||
export function start_or_extend_idle_timer(worker) {
|
||||
function on_idle_timeout() {
|
||||
// We don't do any real error checking here, because
|
||||
// if we've been idle, we need to tell folks, and if
|
||||
// our current recipient has changed, previous code will
|
||||
// have stopped the timer.
|
||||
stop_last_notification(worker);
|
||||
}
|
||||
|
||||
if (state.idle_timer) {
|
||||
clearTimeout(state.idle_timer);
|
||||
}
|
||||
state.idle_timer = setTimeout(on_idle_timeout, TYPING_STOPPED_WAIT_PERIOD);
|
||||
}
|
||||
|
||||
function set_next_start_time(current_time) {
|
||||
state.next_send_start_time = current_time + TYPING_STARTED_WAIT_PERIOD;
|
||||
}
|
||||
|
||||
function actually_ping_server(worker, recipient, current_time) {
|
||||
worker.notify_server_start(recipient);
|
||||
set_next_start_time(current_time);
|
||||
}
|
||||
|
||||
/** Exported only for tests. */
|
||||
export function maybe_ping_server(worker, recipient) {
|
||||
const current_time = worker.get_current_time();
|
||||
if (current_time > state.next_send_start_time) {
|
||||
actually_ping_server(worker, recipient, current_time);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update our state machine, and the server as needed, on the user's typing status.
|
||||
*
|
||||
* This can and should be called frequently, on each keystroke. The
|
||||
* implementation sends "still typing" notices at an appropriate throttled
|
||||
* rate, and keeps a timer to send a "stopped typing" notice when the user
|
||||
* hasn't typed for a few seconds.
|
||||
*
|
||||
* Zulip supports typing notifications only for PMs (both 1:1 and group); so
|
||||
* composing a stream message should be treated like composing no message at
|
||||
* all.
|
||||
*
|
||||
* Call with `new_recipient` of `null` when the user actively stops
|
||||
* composing a message. If the user switches from one set of recipients to
|
||||
* another, there's no need to call with `null` in between; the
|
||||
* implementation tracks the change and behaves appropriately.
|
||||
*
|
||||
* See docs/subsystems/typing-indicators.md for detailed background on the
|
||||
* typing indicators system.
|
||||
*
|
||||
* @param {*} worker Callbacks for reaching the real world. See typing.js
|
||||
* for implementations.
|
||||
* @param {*} new_recipient The users the PM being composed is addressed to,
|
||||
* as a sorted array of user IDs; or `null` if no PM is being composed
|
||||
* anymore.
|
||||
*/
|
||||
export function update(worker, new_recipient) {
|
||||
const current_recipient = state.current_recipient;
|
||||
if (current_recipient !== null) {
|
||||
// We need to use _.isEqual for comparisons; === doesn't work
|
||||
// on arrays.
|
||||
if (_.isEqual(new_recipient, 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);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// We apparently stopped talking to our old recipient,
|
||||
// so we must stop the old notification. Don't return
|
||||
// yet, because we may have a new recipient.
|
||||
stop_last_notification(worker);
|
||||
}
|
||||
|
||||
if (new_recipient === null) {
|
||||
// If we are not talking to somebody we care about,
|
||||
// then there is no more action to take.
|
||||
return;
|
||||
}
|
||||
|
||||
// We just started talking to this recipient, so notify
|
||||
// the server.
|
||||
state.current_recipient = new_recipient;
|
||||
const current_time = worker.get_current_time();
|
||||
actually_ping_server(worker, new_recipient, current_time);
|
||||
start_or_extend_idle_timer(worker);
|
||||
}
|
||||
Reference in New Issue
Block a user