File size: 18,549 Bytes
52efc7b | 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 | /**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import {
AskUserTool,
isCompletedAskUserTool,
type AskUserParams,
type AskUserInvocation,
} from './ask-user.js';
import { QuestionType, type Question } from '../confirmation-bus/types.js';
import type { MessageBus } from '../confirmation-bus/message-bus.js';
import { ToolConfirmationOutcome } from './tools.js';
import { ToolErrorType } from './tool-error.js';
import { ASK_USER_DISPLAY_NAME } from './tool-names.js';
describe('AskUserTool Helpers', () => {
describe('isCompletedAskUserTool', () => {
it('returns false for non-AskUser tools', () => {
expect(isCompletedAskUserTool('other-tool', 'Success')).toBe(false);
});
it('returns true for Success status', () => {
expect(isCompletedAskUserTool(ASK_USER_DISPLAY_NAME, 'Success')).toBe(
true,
);
});
it('returns true for Error status', () => {
expect(isCompletedAskUserTool(ASK_USER_DISPLAY_NAME, 'Error')).toBe(true);
});
it('returns true for Canceled status', () => {
expect(isCompletedAskUserTool(ASK_USER_DISPLAY_NAME, 'Canceled')).toBe(
true,
);
});
it('returns false for in-progress statuses', () => {
expect(isCompletedAskUserTool(ASK_USER_DISPLAY_NAME, 'Executing')).toBe(
false,
);
expect(isCompletedAskUserTool(ASK_USER_DISPLAY_NAME, 'Pending')).toBe(
false,
);
});
});
});
describe('AskUserTool', () => {
let mockMessageBus: MessageBus;
let tool: AskUserTool;
beforeEach(() => {
mockMessageBus = {
publish: vi.fn().mockResolvedValue(undefined),
subscribe: vi.fn(),
unsubscribe: vi.fn(),
} as unknown as MessageBus;
tool = new AskUserTool(mockMessageBus);
});
it('should have correct metadata', () => {
expect(tool.name).toBe('ask_user');
expect(tool.displayName).toBe('Ask User');
});
describe('createInvocation and normalization', () => {
it('should unescape double-escaped newlines in question parameters', async () => {
const params: AskUserParams = {
questions: [
{
question: 'Line 1\\nLine 2',
header: 'Header\\nTest',
placeholder: 'Placeholder\\nTest',
type: QuestionType.CHOICE,
options: [
{ label: 'Option\\n1', description: 'Desc\\n1' },
{ label: 'Option\\n2', description: 'Desc\\n2' },
],
},
],
};
const invocation = (
tool as unknown as {
createInvocation: (
params: AskUserParams,
messageBus: MessageBus,
toolName: string,
toolDisplayName: string,
) => AskUserInvocation;
}
).createInvocation(params, mockMessageBus, 'ask_user', 'Ask User');
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
if (!details || details.type !== 'ask_user') {
throw new Error('Expected ask_user details');
}
expect(details.questions[0].question).toBe('Line 1\nLine 2');
expect(details.questions[0].header).toBe('Header\nTest');
expect(details.questions[0].placeholder).toBe('Placeholder\nTest');
expect(details.questions[0].options?.[0].label).toBe('Option\n1');
expect(details.questions[0].options?.[0].description).toBe('Desc\n1');
});
it('should handle carriage returns and literal newlines', async () => {
const params: AskUserParams = {
questions: [
{
question: 'Line 1\\r\\nLine 2\nLine 3',
header: 'Header',
type: QuestionType.TEXT,
},
],
};
const invocation = (
tool as unknown as {
createInvocation: (
params: AskUserParams,
messageBus: MessageBus,
toolName: string,
toolDisplayName: string,
) => AskUserInvocation;
}
).createInvocation(params, mockMessageBus, 'ask_user', 'Ask User');
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
if (!details || details.type !== 'ask_user') {
throw new Error('Expected ask_user details');
}
expect(details.questions[0].question).toBe('Line 1\nLine 2\nLine 3');
});
});
describe('validateToolParams', () => {
it('should return error if questions is missing', () => {
// @ts-expect-error - Intentionally invalid params
const result = tool.validateToolParams({});
expect(result).toContain("must have required property 'questions'");
});
it('should return error if questions array is empty', () => {
const result = tool.validateToolParams({ questions: [] });
expect(result).toContain('must NOT have fewer than 1 items');
});
it('should return error if questions array exceeds max', () => {
const questions = Array(5).fill({
question: 'Test?',
header: 'Test',
type: QuestionType.CHOICE,
options: [
{ label: 'A', description: 'A' },
{ label: 'B', description: 'B' },
],
});
const result = tool.validateToolParams({ questions });
expect(result).toContain('must NOT have more than 4 items');
});
it('should return error if question field is missing', () => {
const result = tool.validateToolParams({
questions: [{ header: 'Test' } as unknown as Question],
});
expect(result).toContain("must have required property 'question'");
});
it('should return error if header field is missing', () => {
const result = tool.validateToolParams({
questions: [{ question: 'Test?' } as unknown as Question],
});
expect(result).toContain("must have required property 'header'");
});
it('should return error if options has fewer than 2 items', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Test?',
header: 'Test',
type: QuestionType.CHOICE,
options: [{ label: 'A', description: 'A' }],
},
],
});
expect(result).toContain(
"type='choice' requires 'options' array with 2-4 items",
);
});
it('should return error if options has more than 4 items', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Test?',
header: 'Test',
type: QuestionType.CHOICE,
options: [
{ label: 'A', description: 'A' },
{ label: 'B', description: 'B' },
{ label: 'C', description: 'C' },
{ label: 'D', description: 'D' },
{ label: 'E', description: 'E' },
],
},
],
});
expect(result).toContain("'options' array must have at most 4 items");
});
it('should return null for valid params', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Which approach?',
header: 'Approach',
type: QuestionType.CHOICE,
options: [
{ label: 'A', description: 'Option A' },
{ label: 'B', description: 'Option B' },
],
},
],
});
expect(result).toBeNull();
});
it('should return error if choice type has no options', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Pick one?',
header: 'Choice',
type: QuestionType.CHOICE,
},
],
});
expect(result).toContain("type='choice' requires 'options'");
});
it('should return error if type is missing', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Pick one?',
header: 'Choice',
} as unknown as Question,
],
});
expect(result).toContain("must have required property 'type'");
});
it('should accept text type without options', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Enter your name?',
header: 'Name',
type: QuestionType.TEXT,
},
],
});
expect(result).toBeNull();
});
it('should accept yesno type without options', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Do you want to proceed?',
header: 'Confirm',
type: QuestionType.YESNO,
},
],
});
expect(result).toBeNull();
});
it('should accept placeholder for choice type', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Which language?',
header: 'Language',
type: QuestionType.CHOICE,
options: [
{ label: 'TypeScript', description: 'Typed JavaScript' },
{ label: 'JavaScript', description: 'Dynamic language' },
],
placeholder: 'Type another language...',
},
],
});
expect(result).toBeNull();
});
it('should return error if option has empty label', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Pick one?',
header: 'Choice',
type: QuestionType.CHOICE,
options: [
{ label: '', description: 'Empty label' },
{ label: 'B', description: 'Option B' },
],
},
],
});
expect(result).toContain("'label' is required");
});
it('should return error if option is missing description', () => {
const result = tool.validateToolParams({
questions: [
{
question: 'Pick one?',
header: 'Choice',
type: QuestionType.CHOICE,
options: [
{ label: 'A' } as { label: string; description: string },
{ label: 'B', description: 'Option B' },
],
},
],
});
expect(result).toContain("must have required property 'description'");
});
});
describe('validateBuildAndExecute', () => {
it('should hide validation errors from returnDisplay', async () => {
const params = {
questions: [],
};
const result = await tool.validateBuildAndExecute(
params,
new AbortController().signal,
);
expect(result.error).toBeDefined();
expect(result.error?.type).toBe(ToolErrorType.INVALID_TOOL_PARAMS);
expect(result.returnDisplay).toBe('');
});
it('should NOT hide non-validation errors (if any were to occur)', async () => {
const validateParamsSpy = vi
.spyOn(tool, 'validateToolParams')
.mockReturnValue(null);
const params = {
questions: [
{ question: 'Valid?', header: 'Valid', type: QuestionType.TEXT },
],
};
const mockInvocation = {
execute: vi.fn().mockRejectedValue(new Error('Some execution error')),
params,
getDescription: vi.fn().mockReturnValue(''),
toolLocations: vi.fn().mockReturnValue([]),
shouldConfirmExecute: vi.fn().mockResolvedValue(false),
};
const buildSpy = vi.spyOn(tool, 'build').mockReturnValue(mockInvocation);
const result = await tool.validateBuildAndExecute(
params,
new AbortController().signal,
);
expect(result.error).toBeDefined();
expect(result.error?.type).toBe(ToolErrorType.EXECUTION_FAILED);
expect(result.returnDisplay).toBe('Some execution error');
buildSpy.mockRestore();
validateParamsSpy.mockRestore();
});
});
describe('shouldConfirmExecute', () => {
it('should return confirmation details with normalized questions', async () => {
const questions: Question[] = [
{
question: 'How should we proceed with this task?',
header: 'Approach',
type: QuestionType.CHOICE,
options: [
{
label: 'Quick fix (Recommended)',
description:
'Apply the most direct solution to resolve the immediate issue.',
},
{
label: 'Comprehensive refactor',
description:
'Restructure the affected code for better long-term maintainability.',
},
],
multiSelect: false,
},
];
const invocation = tool.build({ questions });
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
expect(details).not.toBe(false);
if (details && details.type === 'ask_user') {
expect(details.title).toBe('Ask User');
expect(details.questions).toEqual(questions);
expect(typeof details.onConfirm).toBe('function');
} else {
// Type guard for TypeScript
expect(details).toBeTruthy();
}
});
it('should use provided question type', async () => {
const questions: Question[] = [
{
question: 'Which approach?',
header: 'Approach',
type: QuestionType.CHOICE,
options: [
{ label: 'Option A', description: 'First option' },
{ label: 'Option B', description: 'Second option' },
],
},
];
const invocation = tool.build({ questions });
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
if (details && details.type === 'ask_user') {
expect(details.questions[0].type).toBe(QuestionType.CHOICE);
}
});
});
describe('execute', () => {
it('should return user answers after confirmation', async () => {
const questions: Question[] = [
{
question: 'How should we proceed with this task?',
header: 'Approach',
type: QuestionType.CHOICE,
options: [
{
label: 'Quick fix (Recommended)',
description:
'Apply the most direct solution to resolve the immediate issue.',
},
{
label: 'Comprehensive refactor',
description:
'Restructure the affected code for better long-term maintainability.',
},
],
multiSelect: false,
},
];
const invocation = tool.build({ questions });
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
// Simulate confirmation with answers
if (details && 'onConfirm' in details) {
const answers = { '0': 'Quick fix (Recommended)' };
await details.onConfirm(ToolConfirmationOutcome.ProceedOnce, {
answers,
});
}
const result = await invocation.execute({
abortSignal: new AbortController().signal,
});
expect(result.returnDisplay).toContain('User answered:');
expect(result.returnDisplay).toContain(
' Approach → Quick fix (Recommended)',
);
expect(JSON.parse(result.llmContent as string)).toEqual({
answers: { '0': 'Quick fix (Recommended)' },
});
expect(result.data).toEqual({
ask_user: {
question_types: [QuestionType.CHOICE],
dismissed: false,
empty_submission: false,
answer_count: 1,
},
});
});
it('should display message when user submits without answering', async () => {
const questions: Question[] = [
{
question: 'Which approach?',
header: 'Approach',
type: QuestionType.CHOICE,
options: [
{ label: 'Option A', description: 'First option' },
{ label: 'Option B', description: 'Second option' },
],
},
];
const invocation = tool.build({ questions });
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
// Simulate confirmation with empty answers
if (details && 'onConfirm' in details) {
await details.onConfirm(ToolConfirmationOutcome.ProceedOnce, {
answers: {},
});
}
const result = await invocation.execute({
abortSignal: new AbortController().signal,
});
expect(result.returnDisplay).toBe(
'User submitted without answering questions.',
);
expect(JSON.parse(result.llmContent as string)).toEqual({ answers: {} });
expect(result.data).toEqual({
ask_user: {
question_types: [QuestionType.CHOICE],
dismissed: false,
empty_submission: true,
answer_count: 0,
},
});
});
it('should handle cancellation', async () => {
const invocation = tool.build({
questions: [
{
question: 'Which sections of the documentation should be updated?',
header: 'Docs',
type: QuestionType.CHOICE,
options: [
{
label: 'User Guide',
description: 'Update the main user-facing documentation.',
},
{
label: 'API Reference',
description: 'Update the detailed API documentation.',
},
],
multiSelect: true,
},
],
});
const details = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
// Simulate cancellation
if (details && 'onConfirm' in details) {
await details.onConfirm(ToolConfirmationOutcome.Cancel);
}
const result = await invocation.execute({
abortSignal: new AbortController().signal,
});
expect(result.returnDisplay).toBe('User dismissed dialog');
expect(result.llmContent).toBe(
'User dismissed ask_user dialog without answering.',
);
expect(result.data).toEqual({
ask_user: {
question_types: [QuestionType.CHOICE],
dismissed: true,
},
});
});
});
});
|