zulip/web/src/typing_events.ts

154 lines
4.7 KiB
TypeScript

import $ from "jquery";
import assert from "minimalistic-assert";
import render_typing_notifications from "../templates/typing_notifications.hbs";
import * as narrow_state from "./narrow_state";
import * as people from "./people";
import {current_user, realm} from "./state_data";
import * as typing_data from "./typing_data";
// See docs/subsystems/typing-indicators.md for details on typing indicators.
// This code handles the inbound side of typing notifications.
// When another user is typing, we process the events here.
//
// We also handle the local event of re-narrowing.
// (For the outbound code, see typing.ts.)
// If number of users typing exceed this,
// we render "Several people are typing..."
const MAX_USERS_TO_DISPLAY_NAME = 3;
// Note!: There are also timing constants in typing_status.ts
// that make typing indicators work.
type UserInfo = {
email: string;
user_id: number;
};
type TypingEvent = {
id: number;
op: "start" | "stop";
type: "typing";
} & (
| {
message_type: "stream";
sender: UserInfo;
stream_id: number;
topic: string;
}
| {
message_type: "direct";
recipients: UserInfo[];
sender: UserInfo;
}
);
function get_users_typing_for_narrow(): number[] {
if (narrow_state.narrowed_by_topic_reply()) {
const current_stream_id = narrow_state.stream_id();
const current_topic = narrow_state.topic();
if (current_stream_id === undefined) {
// narrowed to a stream which doesn't exist.
return [];
}
assert(current_topic !== undefined);
return typing_data.get_topic_typists(current_stream_id, current_topic);
}
if (!narrow_state.narrowed_to_pms()) {
// Narrow is neither "dm:" nor "is:dm" nor topic.
return [];
}
const terms = narrow_state.search_terms();
if (terms[0] === undefined) {
return [];
}
const first_term = terms[0];
if (first_term.operator === "dm") {
// Get list of users typing in this conversation
const narrow_emails_string = first_term.operand;
// TODO: Create people.emails_strings_to_user_ids.
const narrow_user_ids_string = people.reply_to_to_user_ids_string(narrow_emails_string);
if (!narrow_user_ids_string) {
return [];
}
const narrow_user_ids = narrow_user_ids_string
.split(",")
.map((user_id_string) => Number.parseInt(user_id_string, 10));
const group = [...narrow_user_ids, current_user.user_id];
return typing_data.get_group_typists(group);
}
// Get all users typing (in all direct message conversations with current user)
return typing_data.get_all_direct_message_typists();
}
export function render_notifications_for_narrow(): void {
const user_ids = get_users_typing_for_narrow();
const users_typing = user_ids
.map((user_id) => people.get_user_by_id_assert_valid(user_id))
.filter((person) => !person.is_inaccessible_user);
const num_of_users_typing = users_typing.length;
if (num_of_users_typing === 0) {
$("#typing_notifications").hide();
} else {
$("#typing_notifications").html(
render_typing_notifications({
users: users_typing,
several_users: num_of_users_typing > MAX_USERS_TO_DISPLAY_NAME,
}),
);
$("#typing_notifications").show();
}
}
function get_key(event: TypingEvent): string {
if (event.message_type === "stream") {
return typing_data.get_topic_key(event.stream_id, event.topic);
}
if (event.message_type === "direct") {
const recipients = event.recipients.map((user) => user.user_id);
recipients.sort();
return typing_data.get_direct_message_conversation_key(recipients);
}
throw new Error("Invalid typing notification type", event);
}
export function hide_notification(event: TypingEvent): void {
const key = get_key(event);
typing_data.clear_inbound_timer(key);
const removed = typing_data.remove_typist(key, event.sender.user_id);
if (removed) {
render_notifications_for_narrow();
}
}
export function display_notification(event: TypingEvent): void {
const sender_id = event.sender.user_id;
const key = get_key(event);
typing_data.add_typist(key, sender_id);
render_notifications_for_narrow();
typing_data.kickstart_inbound_timer(
key,
realm.server_typing_started_expiry_period_milliseconds,
() => {
hide_notification(event);
},
);
}
export function disable_typing_notification(): void {
typing_data.clear_typing_data();
render_notifications_for_narrow();
}