@ethora/chat-component-rn 26.9.0 → 26.10.0

package/src/networking/xmpp/getHistory.xmpp.ts

@@ -1,25 +1,92 @@
 import { Client, xml } from '@xmpp/client';
-import { createTimeoutPromise } from './createTimeoutPromise.xmpp';
+import { Element } from 'ltx';
 import { IMessage } from '../../types/types';
-import { beginMamQuery, cancelMamQuery } from './mamRouter';
+import { store } from '../../roomStore';
+import { getDataFromXml } from '../../helpers/getDataFromXml';
+import { createMessageFromXml } from '../../helpers/createMessageFromXml';
+import { transformCallLogMessage } from '../../helpers/callLogMessage';
+import { applyMamReactions, extractReaction, ExtractedReaction } from '../../helpers/mamReactions';
+import { getBooleanFromString } from '../../helpers/getBooleanFromString';
+import { getNumberFromString } from '../../helpers/getNumberFromString';
+import { WINDOW_QUERY_PREFIX } from './mamQueryIds';
+import {
+  beginMamQuery,
+  cancelMamQuery,
+  replayArchivedReaction,
+} from './mamRouter';
+import {
+  applyHistoryPageCursor,
+  snapshotRoomHistory,
+} from './historyCursor';
 
-declare const __DEV__: boolean | undefined;
+/** Where a page is read from. Nothing set means the latest page. */
+export interface HistoryPageCursor {
+  /** Page ending just before this archive id (exclusive). */
+  before?: number;
+  /** Page starting just after this archive id (exclusive). */
+  after?: number;
+  /**
+   * MAM time filter (ISO strings). With one and no before/after cursor the
+   * server answers with the FIRST page of the filtered range, oldest first,
+   * which is how a row with no archive id is located by its time.
+   */
+  start?: string;
+  end?: string;
+}
 
-let historyIdCounter = 0;
+/** One archive page together with what the server's `<fin>` said about it. */
+export interface HistoryPage {
+  ok: boolean;
+  /** Oldest first, reactions merged on, reaction stanzas themselves left out. */
+  messages: IMessage[];
+  /** `<fin complete>`: nothing further in the direction that was paged. */
+  complete: boolean;
+  /** RSM `<first>`: archive id of the first row of the page, null when unknown. */
+  first: number | null;
+  /** RSM `<last>`: archive id of the last row of the page, null when unknown. */
+  last: number | null;
+  /** RSM `<count>`: size of the whole (filtered) archive when the server says. */
+  count: number | null;
+  /** Result stanzas the page carried, receipts and reactions included. */
+  received: number;
+  /** `<fin>` was present in the answer. */
+  finSeen: boolean;
+  /** Full room JID the query was addressed to. */
+  roomJid: string;
+}
 
-export const getHistory = async (
-  client: Client,
-  chatJID: string,
-  max: number,
-  before?: number,
-  otherId?: string,
-  options?: { selfApplied?: boolean }
-): Promise<IMessage[] | undefined> => {
-  if (typeof chatJID !== 'string') {return;}
-  // If a caller passes a bare local-part (no `@host`), pick a default
-  // conference based on the client's actual service URL — never leak a
-  // hard-coded dev domain.
-  const fixedChatJid = chatJID.includes('@')
+export interface HistoryPageOptions extends HistoryPageCursor {
+  /** Query id; a default unique one is made when absent. */
+  id?: string;
+  /**
+   * Isolated query: tagged so the global handlers skip its results, never
+   * touches the room's cursor. Implied by after/start/end.
+   */
+  window?: boolean;
+  timeoutMs?: number;
+  /**
+   * The caller merges the returned page into the store itself (the preload
+   * scheduler and the catch-up pass do): the MAM router then does not apply
+   * it. Only meaningful for a live (non-window) page.
+   */
+  selfApplied?: boolean;
+}
+
+const DEFAULT_TIMEOUT_MS = 10000;
+const WINDOW_TIMEOUT_MS = 8000;
+
+let querySeq = 0;
+const nextQueryId = (prefix: string) => {
+  querySeq = (querySeq + 1) % 1_000_000;
+  return `${prefix}${Date.now().toString()}:${querySeq}`;
+};
+
+/**
+ * If a caller passes a bare local-part (no `@host`), pick a default conference
+ * based on the client's actual service URL, never leak a hard-coded dev domain.
+ */
+const toConferenceJid = (client: Client, chatJID: string): string =>
+  chatJID.includes('@')
     ? chatJID
     : (() => {
         const service: string = (client as any)?.options?.service || '';
@@ -28,56 +95,375 @@ export const getHistory = async (
         return `${chatJID}@conference.${host}`;
       })();
 
+const emptyPage = (roomJid: string, ok = false): HistoryPage => ({
+  ok,
+  messages: [],
+  complete: false,
+  first: null,
+  last: null,
+  count: null,
+  received: 0,
+  finSeen: false,
+  roomJid,
+});
 
-  const id = otherId ?? `get-history:${Date.now().toString(36)}-${(++historyIdCounter).toString(36)}`;
+const warnRowSkipped = (error: unknown) => {
+  // One row the parser cannot handle must not cost the whole page.
+  console.log('history row skipped', error);
+};
 
-  const page = beginMamQuery(id, fixedChatJid, !options?.selfApplied);
+const parseRows = async (
+  rows: Element[],
+  roomJid: string
+): Promise<IMessage[]> => {
+  const parsed: IMessage[] = [];
+  // Reaction stanzas carry <reactions> but no body: they update their target
+  // message and are not rendered as messages of their own.
+  const reactionStanzas: Element[] = [];
 
-  const message = xml(
+  for (const msg of rows) {
+    try {
+      if (msg?.getChild('reactions')) {
+        reactionStanzas.push(msg);
+        continue;
+      }
+      const text = msg.getChild('body')?.getText();
+      if (!text) continue;
+
+      const result = await getDataFromXml(msg);
+      if (!result) continue;
+      const { data, id, body, ...rest } = result;
+      if (!data) continue;
+
+      const raw = await createMessageFromXml({
+        data,
+        id,
+        body: body || '',
+        ...rest,
+      } as any);
+      // Server `call-state` archives become friendly call-log entries, the
+      // way the live path turns them.
+      parsed.push(
+        transformCallLogMessage(
+          raw,
+          store.getState().chatSettingStore.user?.xmppUsername || ''
+        )
+      );
+    } catch (error) {
+      warnRowSkipped(error);
+    }
+  }
+
+  // Reactions whose target is in this page are merged onto it; the rest are
+  // replayed into the store (the target may be in an earlier page or live).
+  const reactions: ExtractedReaction[] = [];
+  for (const stanza of reactionStanzas) {
+    try {
+      const reaction = extractReaction(stanza, roomJid);
+      if (reaction) reactions.push(reaction);
+    } catch (error) {
+      warnRowSkipped(error);
+    }
+  }
+  const deferred = applyMamReactions(parsed, reactions);
+  for (const reaction of deferred) {
+    // A store failure on one reaction must not fail the whole archive page.
+    try {
+      replayArchivedReaction(reaction, roomJid);
+    } catch (error) {
+      warnRowSkipped(error);
+    }
+  }
+  return parsed;
+};
+
+const buildMamQuery = (
+  to: string,
+  id: string,
+  max: number,
+  cursor: HistoryPageCursor
+) => {
+  const timeFilter = cursor.start || cursor.end;
+  return xml(
     'iq',
-    {
-      type: 'set',
-      to: fixedChatJid,
-      id: id,
-    },
+    { type: 'set', to, id },
     xml(
       'query',
       { xmlns: 'urn:xmpp:mam:2', queryid: id },
+      timeFilter
+        ? xml(
+            'x',
+            { xmlns: 'jabber:x:data', type: 'submit' },
+            xml(
+              'field',
+              { var: 'FORM_TYPE', type: 'hidden' },
+              xml('value', {}, 'urn:xmpp:mam:2')
+            ),
+            cursor.start
+              ? xml('field', { var: 'start' }, xml('value', {}, cursor.start))
+              : null,
+            cursor.end
+              ? xml('field', { var: 'end' }, xml('value', {}, cursor.end))
+              : null
+          )
+        : null,
       xml(
         'set',
         { xmlns: 'http://jabber.org/protocol/rsm' },
         xml('max', {}, max.toString()),
-        before ? xml('before', {}, before.toString()) : xml('before')
+        cursor.after !== undefined
+          ? xml('after', {}, String(cursor.after))
+          : cursor.before
+            ? xml('before', {}, cursor.before.toString())
+            : timeFilter
+              ? null
+              : xml('before')
       )
     )
   );
+};
+
+/**
+ * One MAM page, read and parsed, with the RSM bounds of the answer. Always
+ * settles: a timeout or an iq error gives `ok: false` and no messages. It
+ * stores nothing (reactions aside); the callers decide what a page means.
+ */
+export const fetchHistoryPage = async (
+  client: Client,
+  chatJID: string,
+  max: number,
+  options: HistoryPageOptions = {}
+): Promise<HistoryPage> => {
+  const roomJid =
+    typeof chatJID === 'string' ? toConferenceJid(client, chatJID) : '';
+  if (!roomJid) return emptyPage('');
 
-  client?.send(message).catch((err: any) => console.log('err on load', err));
+  const isWindow =
+    options.window === true ||
+    options.after !== undefined ||
+    !!options.start ||
+    !!options.end;
+  const id =
+    options.id ??
+    nextQueryId(isWindow ? WINDOW_QUERY_PREFIX : 'get-history:');
+  const timeoutMs =
+    options.timeoutMs ?? (isWindow ? WINDOW_TIMEOUT_MS : DEFAULT_TIMEOUT_MS);
 
-  const timeoutPromise = createTimeoutPromise(10000);
+  let stanzaHdlr: ((stanza: any) => void) | undefined;
+  let timer: ReturnType<typeof setTimeout> | undefined;
 
   try {
-    const res = await Promise.race<IMessage[] | null>([
-      page,
-      timeoutPromise as Promise<null>,
-    ]);
-    if (res === null) {
-      const partial = cancelMamQuery(id);
-      if (typeof __DEV__ !== 'undefined' && __DEV__) {
-        console.log(
-          `[mam] history request for ${fixedChatJid} timed out after 10s (${partial.length} results arrived)`
-        );
+    return await new Promise<HistoryPage>((resolve) => {
+      const rows: Element[] = [];
+      let received = 0;
+      let settled = false;
+      const settle = (page: HistoryPage) => {
+        if (settled) return;
+        settled = true;
+        resolve(page);
+      };
+
+      stanzaHdlr = async (stanza: any) => {
+        try {
+          if (stanza?.is?.('message') && stanza.attrs?.from) {
+            const result = stanza.getChild('result');
+            if (result) {
+              const queryId = result.attrs?.queryid;
+              // Our own queries echo their id: results of a sibling request
+              // for the same room (another page, a window) are not ours.
+              const mine = queryId
+                ? queryId === id
+                : String(stanza.attrs.from).startsWith(roomJid);
+              if (mine) {
+                received += 1;
+                const row = result.getChild('forwarded')?.getChild('message');
+                if (row) rows.push(row);
+              }
+            }
+          }
+
+          if (
+            stanza?.is?.('iq') &&
+            stanza.attrs?.id === id &&
+            stanza.attrs?.type === 'result'
+          ) {
+            const fin = stanza.getChild('fin');
+            const set = fin?.getChild?.('set');
+            const first = set?.getChildText?.('first');
+            const last = set?.getChildText?.('last');
+            const count = set?.getChildText?.('count');
+            const messages = await parseRows(rows, roomJid);
+            settle({
+              ok: true,
+              messages,
+              complete: getBooleanFromString(fin?.attrs?.complete) === true,
+              first: first ? getNumberFromString(first) : null,
+              last: last ? getNumberFromString(last) : null,
+              count: count ? getNumberFromString(count) : null,
+              received,
+              finSeen: !!fin,
+              roomJid,
+            });
+          }
+
+          if (
+            stanza?.is?.('iq') &&
+            stanza.attrs?.id === id &&
+            stanza.attrs?.type === 'error'
+          ) {
+            // No history yet in a fresh room answers with an error: expected.
+            settle(emptyPage(roomJid));
+          }
+        } catch (error) {
+          warnRowSkipped(error);
+          settle(emptyPage(roomJid));
+        }
+      };
+
+      client?.on('stanza', stanzaHdlr);
+      timer = setTimeout(() => settle(emptyPage(roomJid)), timeoutMs);
+
+      Promise.resolve(
+        client?.send(buildMamQuery(roomJid, id, max, options))
+      ).catch((err: any) => {
+        console.log('err on load', err);
+      });
+    });
+  } finally {
+    if (timer) clearTimeout(timer);
+    if (stanzaHdlr) client?.off('stanza', stanzaHdlr);
+  }
+};
+
+/**
+ * A live page: the global stanza handlers parse its rows and the MAM router
+ * batches them into the store (one dispatch per page, capped), so a page is
+ * parsed once. This only watches the wire for what the router does not
+ * keep: the `<fin>` bounds and how many results arrived.
+ */
+const fetchLiveHistoryPage = async (
+  client: Client,
+  chatJID: string,
+  max: number,
+  options: HistoryPageOptions
+): Promise<HistoryPage> => {
+  const roomJid = toConferenceJid(client, chatJID);
+  const id = options.id ?? nextQueryId('get-history:');
+  const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+
+  const page = emptyPage(roomJid);
+  let received = 0;
+  const watcher = (stanza: any) => {
+    try {
+      if (stanza?.is?.('message')) {
+        const result = stanza.getChild('result');
+        if (result && result.attrs?.queryid === id) received += 1;
+        return;
+      }
+      if (stanza?.is?.('iq') && stanza.attrs?.id === id) {
+        if (stanza.attrs?.type === 'error') {
+          page.finSeen = false;
+          return;
+        }
+        const fin = stanza.getChild('fin');
+        const set = fin?.getChild?.('set');
+        const first = set?.getChildText?.('first');
+        const last = set?.getChildText?.('last');
+        const count = set?.getChildText?.('count');
+        page.finSeen = !!fin;
+        page.complete = getBooleanFromString(fin?.attrs?.complete) === true;
+        page.first = first ? getNumberFromString(first) : null;
+        page.last = last ? getNumberFromString(last) : null;
+        page.count = count ? getNumberFromString(count) : null;
       }
-      return partial;
+    } catch (error) {
+      warnRowSkipped(error);
     }
-    return res;
-  } catch (e) {
-    const partial = cancelMamQuery(id);
-    if (typeof __DEV__ !== 'undefined' && __DEV__ && e === undefined) {
-      console.log(
-        `[mam] history request for ${fixedChatJid} got no closing iq within 10s (${partial.length} results arrived)`
-      );
+  };
+
+  client?.on('stanza', watcher);
+  let timer: ReturnType<typeof setTimeout> | undefined;
+  try {
+    const routed = beginMamQuery(id, roomJid, !options.selfApplied);
+    Promise.resolve(
+      client?.send(buildMamQuery(roomJid, id, max, options))
+    ).catch((err: any) => {
+      console.log('err on load', err);
+    });
+    const timeout = new Promise<null>((resolve) => {
+      timer = setTimeout(() => resolve(null), timeoutMs);
+    });
+    try {
+      const messages = await Promise.race<IMessage[] | null>([routed, timeout]);
+      if (messages === null) {
+        // Whatever arrived is still applied by the router and handed back.
+        page.messages = cancelMamQuery(id);
+        page.received = received;
+        return { ...page, ok: false, finSeen: false };
+      }
+      page.messages = messages;
+      page.received = received;
+      page.ok = true;
+      return page;
+    } catch {
+      // The iq error of a fresh room with no history: expected.
+      page.messages = cancelMamQuery(id);
+      page.received = received;
+      return { ...page, ok: false, finSeen: false };
+    }
+  } finally {
+    if (timer) clearTimeout(timer);
+    client?.off('stanza', watcher);
+  }
+};
+
+/**
+ * One page of the room's live history: like fetchHistoryPage, and when the
+ * page feeds the live list (the latest page, or the one before a cursor) the
+ * room's paging cursor follows the server's `<fin>`. A page read by `after`,
+ * a time filter or flagged `window` is an isolated query and writes nothing
+ * (its rows are read by its own listener, never routed into the live list).
+ */
+export const getHistoryPage = async (
+  client: Client,
+  chatJID: string,
+  max: number,
+  options: HistoryPageOptions = {}
+): Promise<HistoryPage> => {
+  if (typeof chatJID !== 'string') return emptyPage('');
+  const isolated =
+    options.window === true ||
+    options.after !== undefined ||
+    !!options.start ||
+    !!options.end;
+  if (isolated) {
+    return fetchHistoryPage(client, chatJID, max, { ...options, window: true });
+  }
+  const snapshot = snapshotRoomHistory(toConferenceJid(client, chatJID));
+  const page = await fetchLiveHistoryPage(client, chatJID, max, options);
+  if (page.ok) {
+    try {
+      applyHistoryPageCursor(page, { before: options.before, max }, snapshot);
+    } catch (error) {
+      warnRowSkipped(error);
     }
-    return partial;
   }
+  return page;
+};
+
+export const getHistory = async (
+  client: Client,
+  chatJID: string,
+  max: number,
+  before?: number,
+  otherId?: string,
+  options?: { selfApplied?: boolean }
+): Promise<IMessage[] | undefined> => {
+  if (typeof chatJID !== 'string') {return;}
+  const page = await getHistoryPage(client, chatJID, max, {
+    before,
+    id: otherId,
+    selfApplied: options?.selfApplied,
+  });
+  return page.messages;
 };

package/src/networking/xmpp/handleStanzas.xmpp.ts

@@ -20,6 +20,7 @@ import {
 } from '../stanzaHandlers';
 import XmppClient from '../xmppClient';
 import { onCallTokenMessage } from '../callTokenStanza';
+import { onEthoraEvent } from '../ethoraEvents';
 import { accountDomain, isE2eeEnabled } from '../../e2ee';
 import {
   decryptStanzaInPlace,
@@ -95,6 +96,13 @@ export const __resetStanzaQueueForTests = (): void => {
 };
 
 function dispatchStanza(stanza: Element, xmppWs: XmppClient) {
+  // `<ethora-event>` server pushes ride on headline messages (also inside a
+  // mucsub wrapper). Handled (or silently ignored when untrusted) before the
+  // headline early return; never throws.
+  if (stanza?.name === 'message') {
+    onEthoraEvent(stanza, xmppWs as any);
+  }
+
   if (stanza?.attrs?.type === 'headline') {return;}
 
   // Call signaling is swallowed before any chat handler sees it. A

package/src/networking/xmpp/historyCursor.ts

@@ -0,0 +1,124 @@
+import { store } from '../../roomStore';
+import { updateRoom } from '../../roomStore/roomsSlice';
+import { IRoom } from '../../types/types';
+
+/** Archive ids are microsecond stamps (16 digits today); anything below this is not one. */
+const MIN_ARCHIVE_ID = 1e14;
+
+export const isArchiveCursor = (value: unknown): value is number =>
+  typeof value === 'number' && Number.isFinite(value) && value > MIN_ARCHIVE_ID;
+
+/** What the room held when a page was requested (a page answers later, and the live handler fills the room meanwhile). */
+export interface RoomHistorySnapshot {
+  hadMessages: boolean;
+  /** Newest archive id among the real cached messages, 0 when none. */
+  newestId: number;
+}
+
+export const snapshotRoomHistory = (roomJid: string): RoomHistorySnapshot => {
+  const messages = store.getState().rooms.rooms?.[roomJid]?.messages || [];
+  let newestId = 0;
+  let hadMessages = false;
+  for (const message of messages) {
+    if (!message || message.id === 'delimiter-new' || message.pending) continue;
+    // Client-only call-log fallbacks never exist on the server.
+    if (String(message.id || '').startsWith('calllog-')) continue;
+    hadMessages = true;
+    const id = Number(message.id);
+    if (isArchiveCursor(id) && id > newestId) newestId = id;
+  }
+  return { hadMessages, newestId };
+};
+
+export interface HistoryPageFin {
+  roomJid: string;
+  /** The `<fin>` element was present in the answer. */
+  finSeen: boolean;
+  complete: boolean;
+  first: number | null;
+  last: number | null;
+  /** Result stanzas the page carried (receipts and reactions included). */
+  received: number;
+}
+
+/**
+ * Write the SERVER's paging cursor after a page that feeds the live list:
+ * room.messageStats.firstMessageTimestamp is the oldest archive id of the
+ * contiguous history (`<fin><set><first>`), room.historyComplete is the fin's
+ * `complete` flag. Windowed queries never come here.
+ *
+ *  - an older page (before set) moves the cursor back, never forward;
+ *  - a LATEST page must not raise an older cursor when the room already had
+ *    messages (a late answer would send the loader back to a page it holds);
+ *  - a full latest page that starts after everything cached leaves a hole, so
+ *    the cursor restarts at the page's oldest id and the room is not complete.
+ */
+export const applyHistoryPageCursor = (
+  page: HistoryPageFin,
+  request: { before?: number; max: number },
+  snapshot: RoomHistorySnapshot
+): void => {
+  if (!page.finSeen || !page.roomJid) return;
+  const room: IRoom | undefined = store.getState().rooms.rooms?.[page.roomJid];
+  if (!room) return;
+
+  const isLatest = request.before === undefined;
+  const known = room.messageStats;
+  const knownCursor = isArchiveCursor(known?.firstMessageTimestamp)
+    ? known?.firstMessageTimestamp
+    : undefined;
+
+  let cursor: number | undefined;
+  let complete: boolean | undefined;
+
+  if (page.first !== null) {
+    if (!isLatest) {
+      cursor =
+        knownCursor !== undefined ? Math.min(knownCursor, page.first) : page.first;
+      complete = page.complete;
+    } else {
+      const gap =
+        snapshot.newestId > 0 &&
+        page.received >= request.max &&
+        page.first > snapshot.newestId;
+      if (gap) {
+        cursor = page.first;
+        complete = false;
+      } else {
+        const keepOlder =
+          snapshot.hadMessages &&
+          knownCursor !== undefined &&
+          knownCursor < page.first;
+        cursor = keepOlder ? knownCursor : page.first;
+        // A latest page proves completeness only when the whole archive fit.
+        if (page.complete) complete = true;
+      }
+    }
+  } else if (!isLatest) {
+    // An older page with nothing in it: the archive has nothing further back.
+    complete = page.complete;
+  } else if (page.complete) {
+    complete = true;
+  }
+
+  const updates: Partial<IRoom> = {};
+  if (typeof complete === 'boolean' && room.historyComplete !== complete) {
+    updates.historyComplete = complete;
+  }
+  const nextFirst = cursor ?? known?.firstMessageTimestamp;
+  const nextLast =
+    isLatest && page.last !== null ? page.last : known?.lastMessageTimestamp;
+  if (
+    (cursor !== undefined && cursor !== known?.firstMessageTimestamp) ||
+    nextLast !== known?.lastMessageTimestamp
+  ) {
+    updates.messageStats = {
+      ...(known || {}),
+      ...(nextFirst !== undefined ? { firstMessageTimestamp: nextFirst } : {}),
+      ...(nextLast !== undefined ? { lastMessageTimestamp: nextLast } : {}),
+    };
+  }
+  if (Object.keys(updates).length) {
+    store.dispatch(updateRoom({ jid: page.roomJid, updates }));
+  }
+};

package/src/networking/xmpp/mamQueryIds.ts

@@ -0,0 +1,11 @@
+/**
+ * MAM query ids. A windowed query (a page around a jump target, a time
+ * lookup) is answered through the same wire as the live history, and the
+ * global stanza handlers see every `<result>` of it. They tell the two apart
+ * by the query id: anything tagged with this prefix belongs to the caller that
+ * asked and must never reach the live message list.
+ */
+export const WINDOW_QUERY_PREFIX = 'window:';
+
+export const isWindowQueryId = (queryId: unknown): boolean =>
+  typeof queryId === 'string' && queryId.startsWith(WINDOW_QUERY_PREFIX);