Repository navigation
Expand file tree
/
Copy pathcreate-thread.test.ts
More file actions
426 lines (368 loc) · 16.2 KB
/
Copy pathcreate-thread.test.ts
File metadata and controls
426 lines (368 loc) · 16.2 KB
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
import type { CommsApi } from '@todoist/comms-sdk'
import { vi } from 'vitest'
import {
createMockThread,
extractStructuredContent,
extractTextContent,
TEST_IDS,
} from '../utils/test-helpers.js'
import { ToolNames } from '../utils/tool-names.js'
import { createThread } from './create-thread.js'
const mockCommsApi = vi.mocked(
{
threads: {
createThread: vi.fn(),
},
inbox: {
unarchiveThread: vi.fn(),
},
} as unknown as CommsApi,
true,
)
const { CREATE_THREAD } = ToolNames
describe(`${CREATE_THREAD} tool`, () => {
beforeEach(() => {
vi.clearAllMocks()
delete process.env.COMMS_CREATE_THREAD_DISPLAY_IN_INBOX
})
describe('creating threads', () => {
it('should create a thread in a channel', async () => {
const mockThread = createMockThread({
title: 'New Discussion',
content: 'Let us discuss this topic',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'New Discussion',
content: 'Let us discuss this topic',
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith({
channelId: TEST_IDS.CHANNEL_1,
title: 'New Discussion',
content: 'Let us discuss this topic',
recipients: undefined,
groups: undefined,
})
expect(mockCommsApi.inbox.unarchiveThread).not.toHaveBeenCalled()
expect(extractTextContent(result)).toMatchSnapshot()
const { structuredContent } = result
expect(structuredContent).toEqual(
expect.objectContaining({
type: 'create_thread_result',
success: true,
threadId: mockThread.id,
title: 'New Discussion',
channelId: TEST_IDS.CHANNEL_1,
workspaceId: TEST_IDS.WORKSPACE_1,
content: 'Let us discuss this topic',
threadUrl: expect.stringContaining('comms.todoist.com'),
}),
)
})
it('should create a thread with recipients', async () => {
const mockThread = createMockThread({
title: 'Notify Users',
content: 'Important update',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Notify Users',
content: 'Important update',
recipients: [TEST_IDS.USER_1, TEST_IDS.USER_2],
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith({
channelId: TEST_IDS.CHANNEL_1,
title: 'Notify Users',
content: 'Important update',
recipients: [TEST_IDS.USER_1, TEST_IDS.USER_2],
groups: undefined,
})
expect(mockCommsApi.inbox.unarchiveThread).not.toHaveBeenCalled()
expect(extractTextContent(result)).toMatchSnapshot()
const structuredContent = extractStructuredContent(result)
expect(structuredContent.recipients).toEqual([TEST_IDS.USER_1, TEST_IDS.USER_2])
expect(structuredContent).not.toHaveProperty('groups')
})
it('should create a thread with groups', async () => {
const mockThread = createMockThread({
title: 'Notify Groups',
content: 'Important group update',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Notify Groups',
content: 'Important group update',
groups: [100, 200],
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith({
channelId: TEST_IDS.CHANNEL_1,
title: 'Notify Groups',
content: 'Important group update',
recipients: undefined,
groups: [100, 200],
})
const structuredContent = extractStructuredContent(result)
expect(structuredContent.groups).toEqual([100, 200])
expect(structuredContent).not.toHaveProperty('recipients')
})
it('should preserve empty groups when creating a thread', async () => {
const mockThread = createMockThread({
title: 'Empty Groups',
content: 'No group recipients',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Empty Groups',
content: 'No group recipients',
groups: [],
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith({
channelId: TEST_IDS.CHANNEL_1,
title: 'Empty Groups',
content: 'No group recipients',
recipients: undefined,
groups: [],
})
const structuredContent = extractStructuredContent(result)
expect(structuredContent.groups).toEqual([])
expect(structuredContent).not.toHaveProperty('recipients')
})
it('should create a thread with recipients and groups', async () => {
const mockThread = createMockThread({
title: 'Notify Users and Groups',
content: 'Important broad update',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Notify Users and Groups',
content: 'Important broad update',
recipients: [TEST_IDS.USER_1],
groups: [100],
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith({
channelId: TEST_IDS.CHANNEL_1,
title: 'Notify Users and Groups',
content: 'Important broad update',
recipients: [TEST_IDS.USER_1],
groups: [100],
})
const structuredContent = extractStructuredContent(result)
expect(structuredContent.recipients).toEqual([TEST_IDS.USER_1])
expect(structuredContent.groups).toEqual([100])
})
it('should forward notifyAudience: channel to notify everyone in the channel', async () => {
const mockThread = createMockThread({
title: 'Everyone',
content: 'For the whole channel',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Everyone',
content: 'For the whole channel',
notifyAudience: 'channel',
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith({
channelId: TEST_IDS.CHANNEL_1,
title: 'Everyone',
content: 'For the whole channel',
recipients: undefined,
groups: undefined,
notifyAudience: 'channel',
})
const structuredContent = extractStructuredContent(result)
expect(structuredContent.notifyAudience).toBe('channel')
expect(extractTextContent(result)).toContain('Everyone in channel')
})
it('should forward notifyAudience alongside explicit recipients', async () => {
const mockThread = createMockThread({
title: 'Everyone plus one',
content: 'Channel and a guest',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Everyone plus one',
content: 'Channel and a guest',
recipients: [TEST_IDS.USER_1],
notifyAudience: 'channel',
},
mockCommsApi,
)
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith(
expect.objectContaining({
recipients: [TEST_IDS.USER_1],
notifyAudience: 'channel',
}),
)
const structuredContent = extractStructuredContent(result)
expect(structuredContent.recipients).toEqual([TEST_IDS.USER_1])
expect(structuredContent.notifyAudience).toBe('channel')
})
it('should forward notifyAudience: thread but report it as not applied at creation', async () => {
const mockThread = createMockThread({
title: 'Interacted only',
content: 'No effect at creation',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Interacted only',
content: 'No effect at creation',
notifyAudience: 'thread',
},
mockCommsApi,
)
// The request is still forwarded to the SDK verbatim...
expect(mockCommsApi.threads.createThread).toHaveBeenCalledWith(
expect.objectContaining({ notifyAudience: 'thread' }),
)
// ...but 'thread' is discarded at thread creation, so it is not
// reported as an applied audience in the structured output.
const structuredContent = extractStructuredContent(result)
expect(structuredContent).not.toHaveProperty('notifyAudience')
expect(extractTextContent(result)).toContain('no effect at thread creation')
})
it('should omit notifyAudience from output when not provided', async () => {
const mockThread = createMockThread({
title: 'No audience',
content: 'Defaults apply',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'No audience',
content: 'Defaults apply',
},
mockCommsApi,
)
const structuredContent = extractStructuredContent(result)
expect(structuredContent).not.toHaveProperty('notifyAudience')
})
it('should unarchive the thread when displayInInbox is true', async () => {
const mockThread = createMockThread({
title: 'Inbox Thread',
content: 'Should appear in Inbox',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
mockCommsApi.inbox.unarchiveThread.mockResolvedValue(undefined as never)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Inbox Thread',
content: 'Should appear in Inbox',
displayInInbox: true,
},
mockCommsApi,
)
expect(mockCommsApi.inbox.unarchiveThread).toHaveBeenCalledWith(mockThread.id)
expect(extractTextContent(result)).toMatchSnapshot()
})
it('should unarchive the thread when COMMS_CREATE_THREAD_DISPLAY_IN_INBOX env var is set', async () => {
process.env.COMMS_CREATE_THREAD_DISPLAY_IN_INBOX = 'true'
const mockThread = createMockThread({
title: 'Env Var Thread',
content: 'Should appear in Inbox via env var',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
mockCommsApi.inbox.unarchiveThread.mockResolvedValue(undefined as never)
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Env Var Thread',
content: 'Should appear in Inbox via env var',
},
mockCommsApi,
)
expect(mockCommsApi.inbox.unarchiveThread).toHaveBeenCalledWith(mockThread.id)
expect(extractTextContent(result)).toMatchSnapshot()
})
it('should not unarchive when displayInInbox is false even if env var is set', async () => {
process.env.COMMS_CREATE_THREAD_DISPLAY_IN_INBOX = 'true'
const mockThread = createMockThread({
title: 'Explicit False Thread',
content: 'Should not unarchive',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Explicit False Thread',
content: 'Should not unarchive',
displayInInbox: false,
},
mockCommsApi,
)
expect(mockCommsApi.inbox.unarchiveThread).not.toHaveBeenCalled()
})
it('should still return a successful result when unarchiveThread fails', async () => {
const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
const mockThread = createMockThread({
title: 'Unarchive Fails',
content: 'Thread created but unarchive failed',
})
mockCommsApi.threads.createThread.mockResolvedValue(mockThread)
mockCommsApi.inbox.unarchiveThread.mockRejectedValue(new Error('Unarchive failed'))
const result = await createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Unarchive Fails',
content: 'Thread created but unarchive failed',
displayInInbox: true,
},
mockCommsApi,
)
expect(mockCommsApi.inbox.unarchiveThread).toHaveBeenCalledWith(mockThread.id)
expect(consoleErrorSpy).toHaveBeenCalled()
const structuredContent = extractStructuredContent(result)
expect(structuredContent.success).toBe(true)
expect(structuredContent.threadId).toBe(mockThread.id)
// Note must not falsely claim the thread is in the Inbox when unarchive failed.
expect(extractTextContent(result)).toContain('do not appear in your own Inbox')
expect(extractTextContent(result)).not.toContain('Thread is in your Inbox')
consoleErrorSpy.mockRestore()
})
})
describe('error handling', () => {
it('should propagate API errors', async () => {
const apiError = new Error('Channel not found')
mockCommsApi.threads.createThread.mockRejectedValue(apiError)
await expect(
createThread.execute(
{
channelId: TEST_IDS.CHANNEL_1,
title: 'Test Thread',
content: 'Test content',
},
mockCommsApi,
),
).rejects.toThrow('Channel not found')
})
})
})