1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
import type { QueuedMessage } from "@dispatch/wire";
import { describe, expect, it } from "vitest";
import {
buildQueueSpec,
cancel,
combine,
drain,
enqueue,
getQueue,
MESSAGE_QUEUE_RENDERER_ID,
MESSAGE_QUEUE_SURFACE_ID,
type MessageQueueState,
type QueueDeps,
} from "./pure.js";
function makeDeps(): QueueDeps {
let idCounter = 0;
let now = 1_000;
return {
id: () => `id-${++idCounter}`,
now: () => (now += 10),
};
}
describe("enqueue", () => {
it("enqueue appends + returns snapshot with the new message (id unique, queuedAt set)", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
const first = enqueue(state, "c1", "first", deps);
expect(first).toHaveLength(1);
const firstMsg = first[0];
if (firstMsg === undefined) throw new Error("expected a message");
expect(firstMsg.id).toBe("id-1");
expect(firstMsg.text).toBe("first");
expect(firstMsg.queuedAt).toBe(1_010);
const second = enqueue(state, "c1", "second", deps);
expect(second).toHaveLength(2);
const secondMsg = second[1];
if (secondMsg === undefined) throw new Error("expected a message");
expect(secondMsg.id).toBe("id-2"); // unique per message
expect(secondMsg.text).toBe("second");
expect(secondMsg.queuedAt).toBe(1_020);
// a separate conversation does not share state
const other = enqueue(state, "c2", "other", deps);
expect(other).toHaveLength(1);
expect(getQueue(state, "c2")).toHaveLength(1);
});
});
describe("getQueue", () => {
it("getQueue returns current snapshot; empty array when none", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
expect(getQueue(state, "unknown")).toEqual([]);
enqueue(state, "c1", "x", deps);
enqueue(state, "c1", "y", deps);
const snap = getQueue(state, "c1");
expect(snap.map((m) => m.text)).toEqual(["x", "y"]);
// returns a COPY — mutating it does not affect live state
snap.push({ id: "evil", text: "mutate", queuedAt: 0 });
expect(getQueue(state, "c1")).toHaveLength(2);
});
});
describe("drain", () => {
it("drain returns all + clears; second drain returns []", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
enqueue(state, "c1", "a", deps);
enqueue(state, "c1", "b", deps);
const drained = drain(state, "c1");
expect(drained.map((m) => m.text)).toEqual(["a", "b"]);
// cleared
expect(getQueue(state, "c1")).toEqual([]);
expect(drain(state, "c1")).toEqual([]);
});
it("drain on an empty queue returns [] and is a no-op", () => {
const state: MessageQueueState = new Map();
// never had a queue
expect(drain(state, "c1")).toEqual([]);
expect(getQueue(state, "c1")).toEqual([]);
// and after a drain that emptied it, draining again is a no-op
const deps = makeDeps();
enqueue(state, "c1", "once", deps);
drain(state, "c1");
expect(drain(state, "c1")).toEqual([]);
expect(getQueue(state, "c1")).toEqual([]);
});
});
describe("cancel", () => {
it("removes the matching message and returns the post-cancel snapshot", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
enqueue(state, "c1", "a", deps); // id-1
enqueue(state, "c1", "b", deps); // id-2
enqueue(state, "c1", "c", deps); // id-3
const snapshot = cancel(state, "c1", "id-2");
expect(snapshot.map((m) => m.id)).toEqual(["id-1", "id-3"]);
expect(snapshot.map((m) => m.text)).toEqual(["a", "c"]);
// live state reflects the removal
expect(getQueue(state, "c1").map((m) => m.id)).toEqual(["id-1", "id-3"]);
});
it("removing the only message drops the key (queue is empty + clean)", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
enqueue(state, "c1", "only", deps); // id-1
const snapshot = cancel(state, "c1", "id-1");
expect(snapshot).toEqual([]);
expect(getQueue(state, "c1")).toEqual([]);
// key removed so a fresh getQueue is a clean empty (not a lingering [] key)
expect(state.has("c1")).toBe(false);
});
it("returns a COPY — mutating the snapshot does not affect live state", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
enqueue(state, "c1", "a", deps);
enqueue(state, "c1", "b", deps);
const snapshot = cancel(state, "c1", "id-1");
snapshot.push({ id: "evil", text: "mutate", queuedAt: 0 });
expect(getQueue(state, "c1")).toHaveLength(1);
});
it("is idempotent — cancelling a missing id is a no-op (returns snapshot without it)", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
enqueue(state, "c1", "a", deps); // id-1
// unknown message id
const snapshot = cancel(state, "c1", "nope");
expect(snapshot.map((m) => m.id)).toEqual(["id-1"]);
expect(getQueue(state, "c1")).toHaveLength(1);
// a second cancel of the already-removed id-1 (re-add then cancel twice)
cancel(state, "c1", "id-1");
expect(getQueue(state, "c1")).toEqual([]);
expect(cancel(state, "c1", "id-1")).toEqual([]); // already gone — no-op
});
it("is scoped per conversation — cancelling on one conversation does not affect another", () => {
const state: MessageQueueState = new Map();
const deps = makeDeps();
enqueue(state, "c1", "a", deps); // id-1
enqueue(state, "c2", "b", deps); // id-2
const snapshot = cancel(state, "c1", "id-1");
expect(snapshot).toEqual([]);
expect(getQueue(state, "c1")).toEqual([]);
// c2 untouched
expect(getQueue(state, "c2").map((m) => m.id)).toEqual(["id-2"]);
});
it("cancelling on an unknown / empty conversation is a no-op (returns [])", () => {
const state: MessageQueueState = new Map();
expect(cancel(state, "unknown", "anything")).toEqual([]);
// unknown id on a conversation that exists but is empty post-drain
const deps = makeDeps();
enqueue(state, "c1", "a", deps);
drain(state, "c1"); // empties + deletes the key
expect(cancel(state, "c1", "id-1")).toEqual([]);
});
});
describe("combine", () => {
it("combine joins texts with blank-line separator", () => {
const msgs: QueuedMessage[] = [
{ id: "1", text: "alpha", queuedAt: 1 },
{ id: "2", text: "beta", queuedAt: 2 },
];
expect(combine(msgs)).toBe("alpha\n\nbeta");
expect(combine([])).toBe("");
expect(combine([{ id: "1", text: "solo", queuedAt: 1 }])).toBe("solo");
});
});
describe("buildQueueSpec", () => {
it("renders a custom field with the queue snapshot", () => {
const msgs: QueuedMessage[] = [
{ id: "1", text: "a", queuedAt: 1 },
{ id: "2", text: "b", queuedAt: 2 },
];
const spec = buildQueueSpec(msgs);
expect(spec.id).toBe(MESSAGE_QUEUE_SURFACE_ID);
expect(spec.region).toBe("side");
expect(spec.title).toBe("Message Queue");
expect(spec.fields).toHaveLength(1);
const field = spec.fields[0];
if (field === undefined || field.kind !== "custom") {
throw new Error("expected a custom field");
}
expect(field.rendererId).toBe(MESSAGE_QUEUE_RENDERER_ID);
const payload = field.payload as { messages: readonly QueuedMessage[] };
expect(payload.messages).toHaveLength(2);
expect(payload.messages.map((m) => m.text)).toEqual(["a", "b"]);
});
it("renders an empty list for an empty queue", () => {
const spec = buildQueueSpec([]);
const field = spec.fields[0];
if (field === undefined || field.kind !== "custom") {
throw new Error("expected a custom field");
}
const payload = field.payload as { messages: readonly QueuedMessage[] };
expect(payload.messages).toEqual([]);
});
});
|
