Merge pull request 'fix(schedule): load scheduled messages from the server; offer to cancel them at logout (#322)' (#382) from fix/scheduled-from-server into lotus

src/app/utils/scheduledMessages.test.ts

@@ -6,6 +6,8 @@ import {
   scheduleMessage,
   cancelScheduledMessage,
   restartScheduledMessage,
+  parseDelayedEvents,
+  groupScheduledByRoom,
 } from './scheduledMessages';
 
 // Minimal MatrixClient stub: records every authedRequest call and returns a
@@ -119,3 +121,61 @@ test('cancel/restart url-encode the delay id', async () => {
   await cancelScheduledMessage(mx, 'a/b c');
   assert.equal(calls[0][1], '/delayed_events/a%2Fb%20c');
 });
+
+test('parseDelayedEvents: Synapse shape, messages only, sendAt from running_since + delay (#322)', () => {
+  const res = {
+    delayed_events: [
+      {
+        delay_id: 'syd_a',
+        room_id: '!r:x',
+        type: 'm.room.message',
+        content: { msgtype: 'm.text', body: 'hi' },
+        delay: 60000,
+        running_since: 1000,
+      },
+      {
+        delay_id: 'syd_call',
+        room_id: '!r:x',
+        type: 'org.matrix.msc3401.call.member',
+        state_key: '_@a:x_D',
+        content: {},
+        delay: 8000,
+        running_since: 1000,
+      },
+      { delay_id: 'syd_bad', room_id: '!r:x', type: 'm.room.message', content: {} },
+      null,
+    ],
+  };
+  assert.deepEqual(parseDelayedEvents(res), [
+    { delayId: 'syd_a', roomId: '!r:x', content: { msgtype: 'm.text', body: 'hi' }, sendAt: 61000 },
+  ]);
+});
+
+test('parseDelayedEvents: MSC `scheduled` shape and garbage', () => {
+  const item = {
+    delay_id: 'd',
+    room_id: '!r:x',
+    type: 'm.room.message',
+    content: { body: 'b' },
+    delay_ms: 5,
+    delayed_since_ts: 10,
+  };
+  assert.equal(parseDelayedEvents({ scheduled: [item] })[0].sendAt, 15);
+  assert.deepEqual(parseDelayedEvents(undefined), []);
+  assert.deepEqual(parseDelayedEvents({ delayed_events: 'nope' }), []);
+});
+
+test('groupScheduledByRoom: groups and sorts by sendAt', () => {
+  const m = (delayId: string, roomId: string, sendAt: number) => ({
+    delayId,
+    roomId,
+    content: {},
+    sendAt,
+  });
+  const g = groupScheduledByRoom([m('b', '!1', 20), m('a', '!1', 10), m('c', '!2', 5)]);
+  assert.deepEqual(
+    g.get('!1')?.map((x) => x.delayId),
+    ['a', 'b'],
+  );
+  assert.equal(g.get('!2')?.length, 1);
+});

src/app/utils/scheduledMessages.ts

@@ -1,4 +1,5 @@
 import { IContent, MatrixClient, Method } from 'matrix-js-sdk';
+import type { ScheduledMessage } from '../state/scheduledMessages';
 
 /**
  * Schedule a message via MSC4140 (delayed messages).
@@ -76,3 +77,61 @@ export async function sendScheduledMessageNow(mx: MatrixClient, delayId: string)
     { prefix: '/_matrix/client/unstable/org.matrix.msc4140' },
   );
 }
+
+type DelayedEventItem = {
+  delay_id?: unknown;
+  room_id?: unknown;
+  type?: unknown;
+  state_key?: unknown;
+  content?: unknown;
+  delay?: unknown;
+  delay_ms?: unknown;
+  running_since?: unknown;
+  delayed_since_ts?: unknown;
+};
+
+/**
+ * [Gitea #322] Pure: the user's pending scheduled messages from an MSC4140
+ * `GET /delayed_events` response. Synapse answers `{ delayed_events: [...] }`;
+ * the current MSC shape is `{ scheduled: [...] }`. Call-membership delayed
+ * events share the endpoint, so only non-state `m.room.message`s are kept.
+ */
+export function parseDelayedEvents(res: unknown): ScheduledMessage[] {
+  if (!res || typeof res !== 'object') return [];
+  const r = res as { delayed_events?: unknown; scheduled?: unknown };
+  const list = Array.isArray(r.delayed_events) ? r.delayed_events : r.scheduled;
+  if (!Array.isArray(list)) return [];
+  const out: ScheduledMessage[] = [];
+  list.forEach((raw: DelayedEventItem) => {
+    if (!raw || typeof raw !== 'object') return;
+    if (raw.type !== 'm.room.message' || raw.state_key !== undefined) return;
+    if (typeof raw.delay_id !== 'string' || typeof raw.room_id !== 'string') return;
+    if (!raw.content || typeof raw.content !== 'object') return;
+    const delay = Number(raw.delay ?? raw.delay_ms);
+    const since = Number(raw.running_since ?? raw.delayed_since_ts);
+    if (!Number.isFinite(delay) || !Number.isFinite(since)) return;
+    out.push({
+      delayId: raw.delay_id,
+      roomId: raw.room_id,
+      content: raw.content as IContent,
+      sendAt: since + delay,
+    });
+  });
+  return out;
+}
+
+/** The user's pending scheduled messages, as the server has them. */
+export async function fetchScheduledMessages(mx: MatrixClient): Promise<ScheduledMessage[]> {
+  const res = await mx.http.authedRequest(Method.Get, '/delayed_events', undefined, undefined, {
+    prefix: '/_matrix/client/unstable/org.matrix.msc4140',
+  });
+  return parseDelayedEvents(res);
+}
+
+/** Group by room, the shape of `scheduledMessagesAtom`. */
+export function groupScheduledByRoom(msgs: ScheduledMessage[]): Map<string, ScheduledMessage[]> {
+  const map = new Map<string, ScheduledMessage[]>();
+  msgs.forEach((m) => map.set(m.roomId, [...(map.get(m.roomId) ?? []), m]));
+  map.forEach((list) => list.sort((a, b) => a.sendAt - b.sendAt));
+  return map;
+}