-
Notifications
You must be signed in to change notification settings - Fork 42k
Expand file tree
/
Copy pathserverToolsSuite.ts
More file actions
1113 lines (1038 loc) · 49.6 KB
/
Copy pathserverToolsSuite.ts
File metadata and controls
1113 lines (1038 loc) · 49.6 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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import assert from 'assert';
import { mkdirSync, mkdtempSync } from 'fs';
import { tmpdir } from 'os';
import { retry } from '../../../../../../base/common/async.js';
import { join } from '../../../../../../base/common/path.js';
import { URI } from '../../../../../../base/common/uri.js';
import { generateUuid } from '../../../../../../base/common/uuid.js';
import { AgentHostActiveAgentTitleGenerationConfigKey, AgentHostArtifactToolsConfigKey } from '../../../../common/agentHostSchema.js';
import { FEEDBACK_ANNOTATION_META_KEY, type IFeedbackAnnotationMeta } from '../../../../common/meta/agentFeedbackAnnotations.js';
import { buildAnnotationsUri } from '../../../../common/annotationsUri.js';
import { buildOpenSessionLinkUri } from '../../../../common/openSessionLink.js';
import { SessionConfigKey } from '../../../../common/sessionConfigKeys.js';
import { ArtifactServerToolName, SessionServerToolName } from '../../../../common/serverToolNames.js';
import { readSessionArtifacts } from '../../../../common/sessionArtifacts.js';
import type { ListSessionsResult, SubscribeResult } from '../../../../common/state/protocol/commands.js';
import { ActionType, NotificationType, type ChatToolCallCompleteAction, type ChatToolCallStartAction, type SessionAddedParams, type StateAction } from '../../../../common/state/sessionActions.js';
import {
buildDefaultChatUri,
readSessionCreationReference,
ROOT_STATE_URI,
type AnnotationsState,
type ChatState,
type RootState,
type SessionState,
} from '../../../../common/state/sessionState.js';
import { PROTOCOL_VERSION } from '../../../../common/state/protocol/version/registry.js';
import { createRealSession, driveChatTurnToCompletion, driveTurnToCompletion, resolveGitHubToken, textFromContent } from '../harness/agentHostE2ETestHarness.js';
import { summarizeAnthropicRequest, summarizeResponsesRequest } from '../harness/capiWireCodec.js';
import { getActionEnvelope, isActionNotification } from '../../serverIntegrationTestHelpers.js';
import type { IAgentHostE2ETestContext } from './e2eTestContext.js';
interface IServerToolTestSession {
readonly sessionUri: string;
readonly chatUri: string;
readonly workspace: string;
}
interface IObservedToolCall {
readonly start: ChatToolCallStartAction;
readonly completion: ChatToolCallCompleteAction;
readonly resultText: string;
}
interface ISeedFeedbackOptions {
readonly id: string;
readonly resource: string;
readonly text: string;
readonly state: IFeedbackAnnotationMeta['state'];
readonly kind?: IFeedbackAnnotationMeta['kind'];
readonly resolved?: boolean;
readonly pendingAgentReveal?: boolean;
readonly replies?: readonly string[];
}
const feedbackToolNames = ['addComment', 'listComments', 'replyToComment', 'deleteComments', 'resolveComments', 'viewUnreviewedComments'] as const;
const feedbackResourceUri = 'untitled://server-tools/reviewed.ts';
const sessionToolNames = [
SessionServerToolName.ListSessions,
SessionServerToolName.GetCurrentSession,
SessionServerToolName.CreateSession,
SessionServerToolName.SendMessage,
SessionServerToolName.GetSessionContext,
SessionServerToolName.DeleteSession,
] as const;
export function defineServerToolsTests(context: IAgentHostE2ETestContext): void {
const { config, createdSessions, tempDirs } = context;
// Claude omits the prior server-tool input from detailed session context.
const supportsFullSessionContext = config.provider !== 'claude';
// Claude reports success but leaves the target listed.
const supportsCrossSessionDelete = config.provider !== 'claude';
// Claude starts another turn instead of rejecting a message to the current chat.
const supportsSelfSendRejection = config.provider !== 'claude';
const createSessionModelTarget = config.createSessionModelTarget;
const createSessionModelWireTarget = config.createSessionModelWireTarget ?? createSessionModelTarget;
// Claude's current-session creation turn does not complete after confirmation.
const supportsCurrentSessionCreation = config.provider !== 'claude';
let nextClientSequence = 10_000;
function reserveClientSequenceBlock(): number {
const start = nextClientSequence;
nextClientSequence += 100;
return start;
}
async function addSession(prefix: string, workspace: string, stableResource = false): Promise<IServerToolTestSession> {
const id = stableResource && config.provider === 'copilotcli' ? `e2e-server-tools-${prefix}` : generateUuid();
const sessionUri = URI.from({ scheme: config.scheme, path: `/${id}` }).toString();
await context.client.call('createSession', {
channel: sessionUri,
provider: config.provider,
workingDirectories: [URI.file(workspace).toString()],
config: { isolation: 'folder' },
}, 30_000);
createdSessions.push(sessionUri);
const chatUri = buildDefaultChatUri(sessionUri);
await context.client.call<SubscribeResult>('subscribe', { channel: sessionUri });
await context.client.call<SubscribeResult>('subscribe', { channel: chatUri });
return { sessionUri, chatUri, workspace };
}
async function createSession(prefix: string, stableResource = false, beforeCreateSession?: () => Promise<void>): Promise<IServerToolTestSession> {
const workspace = mkdtempSync(join(tmpdir(), `ahp-server-tools-${prefix}-`));
tempDirs.push(workspace);
if (!stableResource) {
const sessionUri = await createRealSession(
context.client,
config,
`server-tools-${prefix}-${config.provider}`,
createdSessions,
URI.file(workspace),
beforeCreateSession,
);
context.client.clearReceived();
return { sessionUri, chatUri: buildDefaultChatUri(sessionUri), workspace };
}
context.client.setWorkingDirectory(workspace);
await context.client.call('initialize', {
channel: ROOT_STATE_URI,
protocolVersions: [PROTOCOL_VERSION],
clientId: `server-tools-${prefix}-${config.provider}`,
}, 30_000);
await context.client.call('authenticate', {
channel: ROOT_STATE_URI,
resource: 'https://api.github.com',
token: config.githubToken ?? resolveGitHubToken(),
}, 30_000);
const session = await addSession(prefix, workspace, true);
context.client.clearReceived();
return session;
}
async function sessionState(sessionUri: string): Promise<SessionState> {
const result = await context.client.call<SubscribeResult>('subscribe', { channel: sessionUri });
return result.snapshot!.state as SessionState;
}
async function chatState(chatUri: string): Promise<ChatState> {
const result = await context.client.call<SubscribeResult>('subscribe', { channel: chatUri });
return result.snapshot!.state as ChatState;
}
async function annotationsState(sessionUri: string): Promise<AnnotationsState> {
const result = await context.client.call<SubscribeResult>('subscribe', { channel: buildAnnotationsUri(sessionUri) });
return result.snapshot!.state as AnnotationsState;
}
async function dispatchAndWait(channel: string, action: StateAction): Promise<void> {
const clientSeq = reserveClientSequenceBlock();
context.client.dispatch({ channel, clientSeq, action });
await context.client.waitForNotification(n =>
isActionNotification(n, action.type)
&& getActionEnvelope(n).channel === channel
&& getActionEnvelope(n).origin?.clientSeq === clientSeq,
30_000,
);
}
async function setRootConfig(values: Readonly<Record<string, unknown>>): Promise<void> {
await context.client.call<SubscribeResult>('subscribe', { channel: ROOT_STATE_URI });
await dispatchAndWait(ROOT_STATE_URI, { type: ActionType.RootConfigChanged, config: values });
}
async function seedFeedback(sessionUri: string, options: ISeedFeedbackOptions): Promise<void> {
const annotationsUri = buildAnnotationsUri(sessionUri);
await context.client.call<SubscribeResult>('subscribe', { channel: annotationsUri });
const meta: IFeedbackAnnotationMeta = {
kind: options.kind ?? 'codeReview',
state: options.state,
sessionResource: sessionUri,
...(options.pendingAgentReveal ? { pendingAgentReveal: true } : {}),
};
const entries = [
{ id: `${options.id}:0`, text: options.text },
...(options.replies ?? []).map((text, index) => ({ id: `${options.id}:${index + 1}`, text })),
];
await dispatchAndWait(annotationsUri, {
type: ActionType.AnnotationsSet,
annotation: {
id: options.id,
origin: { session: sessionUri, chat: buildDefaultChatUri(sessionUri), turnId: 'seed-feedback' },
resource: options.resource,
range: { start: { line: 1, character: 2 }, end: { line: 1, character: 8 } },
resolved: options.resolved ?? false,
entries,
_meta: { [FEEDBACK_ANNOTATION_META_KEY]: meta },
},
});
context.client.clearReceived();
}
function toolNameMatches(observed: string, expected: string): boolean {
return observed === expected || observed.endsWith(`__${expected}`);
}
async function driveServerTool(
session: IServerToolTestSession,
turnId: string,
prompt: string,
toolName: string,
options: { readonly success?: boolean; readonly result?: readonly RegExp[] } = {},
): Promise<{ readonly turn: Awaited<ReturnType<typeof driveTurnToCompletion>>; readonly tool: IObservedToolCall }> {
const turn = await driveChatTurnToCompletion(context.client, session.chatUri, turnId, prompt, reserveClientSequenceBlock());
const starts = context.client.receivedNotifications(n => isActionNotification(n, 'chat/toolCallStart'))
.map(n => ({ envelope: getActionEnvelope(n), action: getActionEnvelope(n).action as ChatToolCallStartAction }))
.filter(({ envelope, action }) => envelope.channel === session.chatUri && action.turnId === turnId && toolNameMatches(action.toolName, toolName));
const start = starts.at(-1)?.action;
assert.ok(start, `expected ${turnId} to start server tool ${toolName}`);
assert.notStrictEqual(start.contributor?.kind, 'client');
const completion = context.client.receivedNotifications(n => isActionNotification(n, 'chat/toolCallComplete'))
.map(n => ({ envelope: getActionEnvelope(n), action: getActionEnvelope(n).action as ChatToolCallCompleteAction }))
.find(({ envelope, action }) => envelope.channel === session.chatUri && action.turnId === turnId && action.toolCallId === start.toolCallId)?.action;
assert.ok(completion, `expected ${turnId} to complete server tool ${toolName}`);
assert.strictEqual(completion.result.success, options.success ?? true);
const resultText = textFromContent(completion.result.content ?? []);
if (options.result) {
for (const expected of options.result) {
assert.match(resultText, expected);
}
}
return { turn, tool: { start, completion, resultText } };
}
async function waitForChatIdle(chatUri: string): Promise<ChatState> {
let state = await chatState(chatUri);
if (state.activeTurn) {
const turnId = state.activeTurn.id;
await context.client.waitForNotification(n =>
isActionNotification(n, 'chat/turnComplete')
&& getActionEnvelope(n).channel === chatUri
&& (getActionEnvelope(n).action as { turnId: string }).turnId === turnId,
90_000,
);
state = await chatState(chatUri);
}
assert.strictEqual(state.activeTurn, undefined);
return state;
}
if (context.tier !== 'parity') {
return;
}
function serverToolTest(title: string, run: Mocha.AsyncFunc, enabled = true): void {
(enabled ? test : test.skip)(title, function () {
this.timeout(180_000);
return run.call(this);
});
}
async function materializeSession(session: IServerToolTestSession, turnId: string, marker: string): Promise<void> {
await driveTurnToCompletion(
context.client,
session.sessionUri,
turnId,
`Reply exactly "${marker}".`,
reserveClientSequenceBlock(),
);
}
serverToolTest('server tool: sessions advertise the complete host-owned tool catalog', async function () {
const session = await createSession('catalog');
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-catalog', 'Reply exactly "ready".', reserveClientSequenceBlock());
const toolNames = await retry(async () => {
const state = await sessionState(session.sessionUri);
if (!state.serverTools) {
throw new Error('Server tools have not been advertised');
}
return state.serverTools.map(tool => tool.name);
}, 100, 30);
assert.deepStrictEqual(toolNames, [...feedbackToolNames, ...sessionToolNames]);
});
serverToolTest('server tool: rename_chat renames the chat it runs in', async function () {
try {
const session = await createSession('rename-chat', false, () => setRootConfig({
[AgentHostActiveAgentTitleGenerationConfigKey]: true,
}));
await driveTurnToCompletion(
context.client,
session.sessionUri,
'turn-rename-chat-seed',
'/rename Seeded Chat',
reserveClientSequenceBlock(),
);
const { tool } = await driveServerTool(
session,
'turn-rename-chat',
'Call the rename_chat tool exactly once with title "Coverage audit" and automatic false, then reply with exactly "renamed".',
SessionServerToolName.RenameChat,
);
const renamed = await retry(async () => {
const sessionTitle = (await sessionState(session.sessionUri)).title;
const chatTitle = (await chatState(session.chatUri)).title;
if (sessionTitle !== 'Coverage audit' || chatTitle !== 'Coverage audit') {
throw new Error('The chat rename has not completed');
}
return { sessionTitle, chatTitle };
}, 100, 100);
assert.deepStrictEqual({
succeeded: tool.completion.result.success,
...renamed,
}, {
succeeded: true,
sessionTitle: 'Coverage audit',
chatTitle: 'Coverage audit',
});
} finally {
await setRootConfig({ [AgentHostActiveAgentTitleGenerationConfigKey]: false });
}
});
serverToolTest('server tool: add_artifact_or_reference records a reference in session state', async function () {
try {
const session = await createSession('artifact-add', false, () => setRootConfig({
[AgentHostArtifactToolsConfigKey]: true,
}));
await driveServerTool(
session,
'turn-artifact-add',
'Call add_artifact_or_reference exactly once with type "website", label "Agent Host guide", isArtifact false, and link "https://example.com/agent-host". Then reply with exactly "recorded".',
ArtifactServerToolName.AddArtifactOrReference,
{ result: [/Added reference:/, /Agent Host guide/, /https:\/\/example\.com\/agent-host/] },
);
const [artifact] = readSessionArtifacts((await sessionState(session.sessionUri))._meta);
assert.deepStrictEqual({
artifact: artifact && {
type: artifact.type,
label: artifact.label,
isArtifact: artifact.isArtifact,
link: artifact.link,
},
}, {
artifact: {
type: 'website',
label: 'Agent Host guide',
isArtifact: false,
link: 'https://example.com/agent-host',
},
});
} finally {
await setRootConfig({ [AgentHostArtifactToolsConfigKey]: false });
}
});
serverToolTest('server tool: add_artifact_or_reference rejects a session-management link', async function () {
try {
const session = await createSession('artifact-reject-session', false, () => setRootConfig({
[AgentHostArtifactToolsConfigKey]: true,
}));
const { tool } = await driveServerTool(
session,
'turn-artifact-reject-session',
'Call add_artifact_or_reference exactly once with type "resource", label "Spawned session", isArtifact true, and uri "agent-host-session://copilot/spawned". Then reply with exactly "rejected".',
ArtifactServerToolName.AddArtifactOrReference,
{
success: false,
result: [/sessions and chats created with session-management tools must not be recorded/],
},
);
assert.deepStrictEqual({
succeeded: tool.completion.result.success,
artifacts: readSessionArtifacts((await sessionState(session.sessionUri))._meta),
}, {
succeeded: false,
artifacts: [],
});
} finally {
await setRootConfig({ [AgentHostArtifactToolsConfigKey]: false });
}
});
serverToolTest('server tool: list and remove round-trip a recorded reference', async function () {
try {
const session = await createSession('artifact-list-remove', false, () => setRootConfig({
[AgentHostArtifactToolsConfigKey]: true,
}));
await driveServerTool(
session,
'turn-artifact-list-remove-add',
'Call add_artifact_or_reference exactly once with type "website", label "Design notes", isArtifact false, and link "https://example.com/design". Then reply with exactly "added".',
ArtifactServerToolName.AddArtifactOrReference,
);
const [artifact] = readSessionArtifacts((await sessionState(session.sessionUri))._meta);
assert.ok(artifact);
const listed = await driveServerTool(
session,
'turn-artifact-list-remove-list',
'Call list_artifacts_and_references exactly once, then reply with exactly "listed".',
ArtifactServerToolName.ListArtifactsAndReferences,
);
const removed = await driveServerTool(
session,
'turn-artifact-list-remove-remove',
`Call remove_artifact_or_reference exactly once with id "${artifact.id}", then reply with exactly "removed".`,
ArtifactServerToolName.RemoveArtifactOrReference,
);
assert.deepStrictEqual({
listed: listed.tool.resultText.includes(`${artifact.id} (website, reference) Design notes — https://example.com/design`),
removed: removed.tool.resultText.includes(`Removed reference: ${artifact.id}`),
artifacts: readSessionArtifacts((await sessionState(session.sessionUri))._meta),
}, {
listed: true,
removed: true,
artifacts: [],
});
} finally {
await setRootConfig({ [AgentHostArtifactToolsConfigKey]: false });
}
});
serverToolTest('server tool: listComments executes in-process with an empty annotation channel', async function () {
const session = await createSession('comments-empty');
const { tool } = await driveServerTool(
session,
'turn-comments-empty',
'Call the listComments tool exactly once, then reply with exactly "listed".',
'listComments',
);
assert.deepStrictEqual(JSON.parse(tool.resultText), { comments: [] });
});
serverToolTest('server tool: addComment converts a one-based input range to the zero-based annotations range', async function () {
const session = await createSession('comment-add');
await driveServerTool(
session,
'turn-comment-add',
`Call addComment exactly once for ${feedbackResourceUri} with range startLineNumber 1, startColumn 7, endLineNumber 1, endColumn 13 and text "rename this", then reply exactly "added".`,
'addComment',
{ result: [/Comment added/] },
);
const annotations = (await annotationsState(session.sessionUri)).annotations;
assert.deepStrictEqual(annotations.map(annotation => ({
resource: annotation.resource,
range: annotation.range,
text: annotation.entries?.[0]?.text,
meta: annotation._meta?.[FEEDBACK_ANNOTATION_META_KEY],
})), [{
resource: feedbackResourceUri,
range: { start: { line: 0, character: 6 }, end: { line: 0, character: 12 } },
text: 'rename this',
meta: { kind: 'codeReview', state: 'created', sessionResource: session.sessionUri },
}]);
});
serverToolTest('server tool: listComments returns accepted feedback and reports hidden review feedback', async function () {
const session = await createSession('comments-list');
const resource = feedbackResourceUri;
await seedFeedback(session.sessionUri, { id: 'accepted-comment', resource, text: 'visible', state: 'accepted', replies: ['reply'] });
await seedFeedback(session.sessionUri, { id: 'hidden-comment', resource, text: 'hidden', state: 'created' });
const { tool } = await driveServerTool(
session,
'turn-comments-list',
'Call listComments exactly once, then reply exactly "listed".',
'listComments',
);
const result = JSON.parse(tool.resultText) as { comments: readonly { id: string; author?: string; replies?: readonly { author: string; text: string }[] }[]; note?: string };
assert.deepStrictEqual({
comments: result.comments.map(comment => ({ id: comment.id, author: comment.author, replies: comment.replies })),
noteMentionsUnreviewed: result.note?.includes('1 code review comment') ?? false,
}, {
// The seeded entries carry no author, so the comment falls back to its
// `codeReview` origin and the reply to the user.
comments: [{ id: 'accepted-comment', author: 'agent', replies: [{ author: 'user', text: 'reply' }] }],
noteMentionsUnreviewed: true,
});
});
serverToolTest('server tool: resolveComments marks accepted feedback resolved', async function () {
const session = await createSession('comment-resolve');
const resource = feedbackResourceUri;
await seedFeedback(session.sessionUri, { id: 'resolve-me', resource, text: 'resolve', state: 'accepted' });
await driveServerTool(
session,
'turn-comment-resolve',
'Call resolveComments exactly once with commentIds ["resolve-me"], then reply exactly "resolved".',
'resolveComments',
{ result: [/"updatedCommentIds":\s*\[\s*"resolve-me"/] },
);
const annotation = (await annotationsState(session.sessionUri)).annotations.find(annotation => annotation.id === 'resolve-me');
assert.deepStrictEqual({
resolved: annotation?.resolved,
state: (annotation?._meta?.[FEEDBACK_ANNOTATION_META_KEY] as IFeedbackAnnotationMeta | undefined)?.state,
}, {
resolved: true,
state: 'resolved',
});
});
serverToolTest('server tool: resolveComments can reopen resolved feedback', async function () {
const session = await createSession('comment-reopen');
const resource = feedbackResourceUri;
await seedFeedback(session.sessionUri, { id: 'reopen-me', resource, text: 'reopen', state: 'resolved', resolved: true });
await driveServerTool(
session,
'turn-comment-reopen',
'Call resolveComments exactly once with commentIds ["reopen-me"] and resolved false, then reply exactly "reopened".',
'resolveComments',
{ result: [/"resolved":\s*false/] },
);
const annotation = (await annotationsState(session.sessionUri)).annotations.find(annotation => annotation.id === 'reopen-me');
assert.deepStrictEqual({
resolved: annotation?.resolved,
state: (annotation?._meta?.[FEEDBACK_ANNOTATION_META_KEY] as IFeedbackAnnotationMeta | undefined)?.state,
}, {
resolved: false,
state: 'submitted',
});
});
serverToolTest('server tool: deleteComments removes accepted feedback without touching hidden feedback', async function () {
const session = await createSession('comment-delete');
const resource = feedbackResourceUri;
await seedFeedback(session.sessionUri, { id: 'delete-me', resource, text: 'delete', state: 'accepted' });
await seedFeedback(session.sessionUri, { id: 'keep-hidden', resource, text: 'hidden', state: 'created' });
const hiddenBefore = (await annotationsState(session.sessionUri)).annotations.find(annotation => annotation.id === 'keep-hidden');
assert.ok(hiddenBefore);
await driveServerTool(
session,
'turn-comment-delete',
'Call deleteComments exactly once with commentIds ["delete-me"], then reply exactly "deleted".',
'deleteComments',
{ result: [/"deletedCommentIds":\s*\[\s*"delete-me"/] },
);
assert.deepStrictEqual((await annotationsState(session.sessionUri)).annotations, [hiddenBefore]);
});
serverToolTest('server tool: viewUnreviewedComments returns selected feedback and clears pending reveal state', async function () {
const session = await createSession('comments-view');
const resource = feedbackResourceUri;
await seedFeedback(session.sessionUri, {
id: 'reveal-me',
resource,
text: 'revealed',
state: 'accepted',
kind: 'prReview',
pendingAgentReveal: true,
});
const { turn, tool } = await driveServerTool(
session,
'turn-comments-view',
'Call viewUnreviewedComments exactly once, then reply exactly "viewed".',
'viewUnreviewedComments',
{ result: [/"id":\s*"reveal-me"/] },
);
assert.strictEqual(turn.sawPendingConfirmation, true);
const annotation = (await annotationsState(session.sessionUri)).annotations.find(annotation => annotation.id === 'reveal-me');
assert.deepStrictEqual({
pendingAgentReveal: (annotation?._meta?.[FEEDBACK_ANNOTATION_META_KEY] as IFeedbackAnnotationMeta | undefined)?.pendingAgentReveal,
result: (JSON.parse(tool.resultText) as { comments: readonly { id: string }[] }).comments.map(comment => comment.id),
}, {
pendingAgentReveal: undefined,
result: ['reveal-me'],
});
});
serverToolTest('server tool: get_current_session returns the invoking session metadata and open link', async function () {
const session = await createSession('current-session');
const { tool } = await driveServerTool(
session,
'turn-current-session',
'Call get_current_session exactly once, then reply exactly "current".',
SessionServerToolName.GetCurrentSession,
);
const result = JSON.parse(tool.resultText) as { session: string; openLink: string; workingDirectory?: string };
assert.deepStrictEqual({
session: result.session,
openLink: result.openLink,
workingDirectory: result.workingDirectory,
}, {
session: session.sessionUri,
openLink: buildOpenSessionLinkUri(URI.parse(session.sessionUri)),
workingDirectory: URI.file(session.workspace).toString(),
});
});
serverToolTest('server tool: list_sessions returns live session metadata', async function () {
const session = await createSession('sessions-list');
const { tool } = await driveServerTool(
session,
'turn-sessions-list',
`Call list_sessions exactly once with workspace "${session.workspace}", then reply exactly "listed".`,
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string; workingDirectory?: string }[] };
assert.deepStrictEqual(result.sessions.map(item => ({
session: item.session,
workingDirectory: item.workingDirectory,
})), [{
session: session.sessionUri,
workingDirectory: URI.file(session.workspace).toString(),
}]);
});
serverToolTest('server tool: list_sessions direct lookup accepts an open-session link', async function () {
const session = await createSession('sessions-direct', true);
const openLink = buildOpenSessionLinkUri(URI.parse(session.sessionUri));
const { tool } = await driveServerTool(
session,
'turn-sessions-direct',
`Call list_sessions exactly once with session "${openLink}", then reply exactly "found".`,
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.deepStrictEqual(result.sessions.map(item => item.session), [session.sessionUri]);
});
serverToolTest('server tool: list_sessions workspace filter excludes sessions in other folders', async function () {
const session = await createSession('sessions-workspace');
const otherWorkspace = join(session.workspace, 'other');
mkdirSync(otherWorkspace);
const other = await addSession('sessions-workspace-other', otherWorkspace);
await materializeSession(other, 'turn-sessions-workspace-target', 'WORKSPACE_TARGET_READY');
context.client.clearReceived();
const { tool } = await driveServerTool(
session,
'turn-sessions-workspace',
`Call list_sessions exactly once with workspace "${otherWorkspace}", then reply exactly "filtered".`,
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.deepStrictEqual(result.sessions.map(item => item.session), [other.sessionUri]);
});
serverToolTest('server tool: list_sessions can include an archived session on request', async function () {
const session = await createSession('sessions-archived');
const archived = await addSession('sessions-archived-target', session.workspace);
await materializeSession(archived, 'turn-sessions-archived-target', 'ARCHIVED_TARGET_READY');
await dispatchAndWait(archived.sessionUri, { type: ActionType.SessionIsArchivedChanged, isArchived: true });
context.client.clearReceived();
const { tool } = await driveServerTool(
session,
'turn-sessions-archived',
'Call list_sessions exactly once with status ["archived"], then reply exactly "listed".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string; status?: string }[] };
assert.deepStrictEqual(result.sessions.find(item => item.session === archived.sessionUri)?.status?.split(',').sort(), ['archived', 'idle']);
});
serverToolTest('server tool: list_sessions hides archived sessions by default', async function () {
const session = await createSession('sessions-hide-archived');
const archived = await addSession('sessions-hide-archived-target', session.workspace);
await materializeSession(archived, 'turn-sessions-hide-archived-target', 'ARCHIVED_HIDDEN_READY');
await dispatchAndWait(archived.sessionUri, { type: ActionType.SessionIsArchivedChanged, isArchived: true });
context.client.clearReceived();
const { tool } = await driveServerTool(
session,
'turn-sessions-hide-archived',
`Call list_sessions exactly once with workspace "${session.workspace}", then reply exactly "listed".`,
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.deepStrictEqual({
includesActive: result.sessions.some(item => item.session === session.sessionUri),
includesArchived: result.sessions.some(item => item.session === archived.sessionUri),
}, {
includesActive: true,
includesArchived: false,
});
});
serverToolTest('server tool: list_sessions includeArchived returns active and archived sessions', async function () {
const session = await createSession('sessions-include-archived');
const archived = await addSession('sessions-include-archived-target', session.workspace);
await materializeSession(archived, 'turn-sessions-include-archived-target', 'ARCHIVED_INCLUDED_READY');
await dispatchAndWait(archived.sessionUri, { type: ActionType.SessionIsArchivedChanged, isArchived: true });
context.client.clearReceived();
const { tool } = await driveServerTool(
session,
'turn-sessions-include-archived',
`Call list_sessions exactly once with workspace "${session.workspace}" and includeArchived true, then reply exactly "listed".`,
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
const returned = new Set(result.sessions.map(item => item.session));
assert.deepStrictEqual({
includesActive: returned.has(session.sessionUri),
includesArchived: returned.has(archived.sessionUri),
}, {
includesActive: true,
includesArchived: true,
});
});
serverToolTest('server tool: list_sessions status filter finds the invoking in-progress session', async function () {
const session = await createSession('sessions-status');
const { tool } = await driveServerTool(
session,
'turn-sessions-status',
'Call list_sessions exactly once with status ["inProgress"], then reply exactly "filtered".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string; status?: string }[] };
assert.deepStrictEqual(result.sessions.map(item => ({ session: item.session, status: item.status })), [{
session: session.sessionUri,
status: 'inProgress',
}]);
});
serverToolTest('server tool: list_sessions status filter combines active and archived sessions', async function () {
const session = await createSession('sessions-status-combined');
const archived = await addSession('sessions-status-combined-target', session.workspace);
await materializeSession(archived, 'turn-sessions-status-combined-target', 'COMBINED_TARGET_READY');
await dispatchAndWait(archived.sessionUri, { type: ActionType.SessionIsArchivedChanged, isArchived: true });
context.client.clearReceived();
const { tool } = await driveServerTool(
session,
'turn-sessions-status-combined',
'Call list_sessions exactly once with status ["inProgress", "archived"], then reply exactly "filtered".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
const returned = new Set(result.sessions.map(item => item.session));
assert.deepStrictEqual({
includesActive: returned.has(session.sessionUri),
includesArchived: returned.has(archived.sessionUri),
}, {
includesActive: true,
includesArchived: true,
});
});
serverToolTest('server tool: list_sessions unread filter returns the invoking unread session', async function () {
const session = await createSession('sessions-unread');
const { tool } = await driveServerTool(
session,
'turn-sessions-unread',
'Call list_sessions exactly once with unread true, then reply exactly "filtered".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string; unread?: boolean }[] };
assert.deepStrictEqual(result.sessions.map(item => ({ session: item.session, unread: item.unread })), [{
session: session.sessionUri,
unread: true,
}]);
});
serverToolTest('server tool: list_sessions createdAfter accepts current sessions', async function () {
const session = await createSession('sessions-created-after');
const { tool } = await driveServerTool(
session,
'turn-sessions-created-after',
`Call list_sessions exactly once with workspace "${session.workspace}" and createdAfter "2000-01-01T00:00:00Z", then reply exactly "filtered".`,
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.ok(result.sessions.some(item => item.session === session.sessionUri));
});
serverToolTest('server tool: list_sessions createdAfter excludes sessions before the boundary', async function () {
const session = await createSession('sessions-created-after-exclude');
const { tool } = await driveServerTool(
session,
'turn-sessions-created-after-exclude',
'Call list_sessions exactly once with createdAfter "2999-01-01T00:00:00Z", then reply exactly "filtered".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.strictEqual(result.sessions.some(item => item.session === session.sessionUri), false);
});
serverToolTest('server tool: list_sessions createdBefore excludes current sessions', async function () {
const session = await createSession('sessions-created-before');
const { tool } = await driveServerTool(
session,
'turn-sessions-created-before',
'Call list_sessions exactly once with createdBefore "2000-01-01T00:00:00Z", then reply exactly "filtered".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.strictEqual(result.sessions.some(item => item.session === session.sessionUri), false);
});
serverToolTest('server tool: list_sessions createdBefore accepts sessions before a future boundary', async function () {
const session = await createSession('sessions-created-before-include');
const { tool } = await driveServerTool(
session,
'turn-sessions-created-before-include',
'Call list_sessions exactly once with createdBefore "2999-01-01T00:00:00Z", then reply exactly "filtered".',
SessionServerToolName.ListSessions,
);
const result = JSON.parse(tool.resultText) as { sessions: readonly { session: string }[] };
assert.ok(result.sessions.some(item => item.session === session.sessionUri));
});
serverToolTest('server tool: create_session currentSession starts a prompt in a peer chat', async function () {
const session = await createSession('create-chat-default');
const before = new Set((await sessionState(session.sessionUri)).chats.map(chat => chat.resource));
const { turn } = await driveServerTool(
session,
'turn-create-chat-default',
'Call create_session exactly once with relationship "currentSession", prompt "/rename Created Peer", and title "Created Peer", then reply exactly "created".',
SessionServerToolName.CreateSession,
);
const after = await sessionState(session.sessionUri);
const peer = after.chats.find(chat => !before.has(chat.resource));
assert.ok(peer);
const peerState = await waitForChatIdle(peer.resource);
assert.deepStrictEqual({
sawPendingConfirmation: turn.sawPendingConfirmation,
messages: peerState.turns.map(turn => turn.message.text),
}, {
sawPendingConfirmation: true,
messages: ['/rename Created Peer'],
});
}, config.supportsMultipleChats && supportsCurrentSessionCreation);
serverToolTest('server tool: create_session currentSession applies an explicit peer title', async function () {
const session = await createSession('create-chat-title');
const before = new Set((await sessionState(session.sessionUri)).chats.map(chat => chat.resource));
await driveServerTool(
session,
'turn-create-chat-title',
'Call create_session exactly once with relationship "currentSession", prompt "/rename", and title "Explicit Peer", then reply exactly "created".',
SessionServerToolName.CreateSession,
);
const after = await sessionState(session.sessionUri);
const peer = after.chats.find(chat => !before.has(chat.resource));
assert.ok(peer);
await waitForChatIdle(peer.resource);
assert.strictEqual((await sessionState(session.sessionUri)).chats.find(chat => chat.resource === peer.resource)?.title, 'Explicit Peer');
}, config.supportsMultipleChats && supportsCurrentSessionCreation);
serverToolTest('server tool: get_session_context summary includes a completed prior turn', async function () {
const session = await createSession('context-summary', true);
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-context-seed', 'Reply exactly "CONTEXT_READY".', reserveClientSequenceBlock());
const { tool } = await driveServerTool(
session,
'turn-context-summary',
`Call get_session_context exactly once with session "${session.sessionUri}", then reply exactly "read".`,
SessionServerToolName.GetSessionContext,
);
const result = JSON.parse(tool.resultText) as { detail: string; transcript: readonly { user?: string; assistant?: string }[] };
assert.deepStrictEqual({
detail: result.detail,
first: result.transcript[0],
}, {
detail: 'summary',
first: { turn: 1, state: 'complete', user: 'Reply exactly "CONTEXT_READY".', assistant: 'CONTEXT_READY' },
});
});
serverToolTest('server tool: get_session_context accepts explicit summary detail', async function () {
const session = await createSession('context-explicit-summary', true);
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-context-explicit-summary-seed', 'Reply exactly "SUMMARY_READY".', reserveClientSequenceBlock());
const { tool } = await driveServerTool(
session,
'turn-context-explicit-summary',
`Call get_session_context exactly once with session "${session.sessionUri}" and detail "summary", then reply exactly "read".`,
SessionServerToolName.GetSessionContext,
);
const result = JSON.parse(tool.resultText) as { detail: string; transcript: readonly { user?: string; assistant?: string }[] };
assert.deepStrictEqual({
detail: result.detail,
first: result.transcript[0],
}, {
detail: 'summary',
first: {
turn: 1,
state: 'complete',
user: 'Reply exactly "SUMMARY_READY".',
assistant: 'SUMMARY_READY',
},
});
});
serverToolTest('server tool: get_session_context accepts an open-session link', async function () {
const session = await createSession('context-link', true);
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-context-link-seed', 'Reply exactly "LINK_READY".', reserveClientSequenceBlock());
const link = buildOpenSessionLinkUri(URI.parse(session.sessionUri));
const { tool } = await driveServerTool(
session,
'turn-context-link',
`Call get_session_context exactly once with session "${link}", then reply exactly "read".`,
SessionServerToolName.GetSessionContext,
);
const result = JSON.parse(tool.resultText) as { transcript: readonly { user?: string; assistant?: string }[] };
assert.deepStrictEqual(result.transcript[0], {
turn: 1,
state: 'complete',
user: 'Reply exactly "LINK_READY".',
assistant: 'LINK_READY',
});
});
serverToolTest('server tool: get_session_context digest includes completed response text', async function () {
const session = await createSession('context-digest', true);
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-context-digest-seed', 'Reply exactly "DIGEST_READY".', reserveClientSequenceBlock());
const { tool } = await driveServerTool(
session,
'turn-context-digest',
`Call get_session_context exactly once with session "${session.sessionUri}" and detail "digest", then reply exactly "read".`,
SessionServerToolName.GetSessionContext,
);
const result = JSON.parse(tool.resultText) as { detail: string; transcript: readonly { user?: string; assistant?: string }[] };
assert.deepStrictEqual({
detail: result.detail,
first: result.transcript[0],
}, {
detail: 'digest',
first: {
turn: 1,
state: 'complete',
user: 'Reply exactly "DIGEST_READY".',
assistant: 'DIGEST_READY',
},
});
});
serverToolTest('server tool: get_session_context full includes prior server-tool input', async function () {
const session = await createSession('context-full', true);
await driveServerTool(
session,
'turn-context-tool-seed',
'Call list_sessions exactly once with no filters, then reply exactly "SEEDED".',
SessionServerToolName.ListSessions,
);
const { tool } = await driveServerTool(
session,
'turn-context-full',
`Call get_session_context exactly once with session "${session.sessionUri}" and detail "full", then reply exactly "read".`,
SessionServerToolName.GetSessionContext,
);
const result = JSON.parse(tool.resultText) as { transcript: readonly { toolCalls?: readonly { name: string; input?: string }[] }[] };
assert.deepStrictEqual(result.transcript[0]?.toolCalls, [{ name: SessionServerToolName.ListSessions, input: '{}' }]);
}, supportsFullSessionContext);
serverToolTest('server tool: get_session_context transcriptLimit keeps only the newest turn', async function () {
const session = await createSession('context-limit', true);
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-context-old', 'Reply exactly "OLD".', reserveClientSequenceBlock());
await driveTurnToCompletion(context.client, session.sessionUri, 'turn-context-new', 'Reply exactly "NEW".', reserveClientSequenceBlock());
const { tool } = await driveServerTool(
session,
'turn-context-limit',
`Call get_session_context exactly once with session "${session.sessionUri}" and transcriptLimit 1, then reply exactly "read".`,
SessionServerToolName.GetSessionContext,
);
const result = JSON.parse(tool.resultText) as { transcript: readonly { user?: string }[]; truncated: boolean };
assert.deepStrictEqual({
users: result.transcript.map(turn => turn.user),
truncated: result.truncated,
}, {
users: [`Call get_session_context exactly once with session "${session.sessionUri}" and transcriptLimit 1, then reply exactly "read".`],
truncated: true,
});
});
serverToolTest('server tool: send_message starts a turn in another session', async function () {
const session = await createSession('send-message', true);
const target = await addSession('send-message-target', session.workspace, true);
await materializeSession(target, 'turn-send-message-target-seed', 'TARGET_MATERIALIZED');
context.client.clearReceived();
const { turn } = await driveServerTool(
session,
'turn-send-message',
`Call send_message exactly once with session "${target.sessionUri}" and message "/rename Target Via Send", then reply exactly "sent".`,
SessionServerToolName.SendMessage,
);
const targetState = await waitForChatIdle(target.chatUri);
assert.deepStrictEqual({
sawPendingConfirmation: turn.sawPendingConfirmation,
messages: targetState.turns.map(turn => turn.message.text),
}, {
sawPendingConfirmation: true,
messages: ['Reply exactly "TARGET_MATERIALIZED".', '/rename Target Via Send'],
});
});
serverToolTest('server tool: create_session materializes a selected-model child session and starts its prompt', async function () {
assert.ok(createSessionModelTarget);
const session = await createSession('create-session');
await materializeSession(session, 'turn-create-session-seed', 'PARENT_READY');
const childPrompt = 'Reply exactly CHILD_READY.';
const root = await context.client.call<SubscribeResult>('subscribe', { channel: ROOT_STATE_URI });
const model = (root.snapshot!.state as RootState).agents
.find(agent => agent.provider === config.provider)
?.models.find(model => model.id === createSessionModelTarget);
assert.ok(model);
context.client.clearReceived();