mirror of
https://github.com/QwenLM/qwen-code.git
synced 2026-04-28 19:52:02 +00:00
1136 lines
35 KiB
TypeScript
1136 lines
35 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2025 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import type { Mock } from 'vitest';
|
|
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
import { handleAtCommand } from './atCommandProcessor.js';
|
|
import type { Config } from '@qwen-code/qwen-code-core';
|
|
import {
|
|
FileDiscoveryService,
|
|
StandardFileSystemService,
|
|
COMMON_IGNORE_PATTERNS,
|
|
// DEFAULT_FILE_EXCLUDES,
|
|
} from '@qwen-code/qwen-code-core';
|
|
import * as os from 'node:os';
|
|
import { ToolCallStatus } from '../types.js';
|
|
import type { UseHistoryManagerReturn } from './useHistoryManager.js';
|
|
import * as fsPromises from 'node:fs/promises';
|
|
import * as path from 'node:path';
|
|
|
|
describe('handleAtCommand', () => {
|
|
let testRootDir: string;
|
|
let mockConfig: Config;
|
|
|
|
const mockAddItem: Mock<UseHistoryManagerReturn['addItem']> = vi.fn();
|
|
const mockOnDebugMessage: Mock<(message: string) => void> = vi.fn();
|
|
|
|
let abortController: AbortController;
|
|
|
|
async function createTestFile(fullPath: string, fileContents: string) {
|
|
await fsPromises.mkdir(path.dirname(fullPath), { recursive: true });
|
|
await fsPromises.writeFile(fullPath, fileContents);
|
|
return path.resolve(testRootDir, fullPath);
|
|
}
|
|
|
|
beforeEach(async () => {
|
|
vi.resetAllMocks();
|
|
|
|
testRootDir = await fsPromises.mkdtemp(
|
|
path.join(os.tmpdir(), 'folder-structure-test-'),
|
|
);
|
|
|
|
abortController = new AbortController();
|
|
|
|
mockConfig = {
|
|
getTargetDir: () => testRootDir,
|
|
getProjectRoot: () => testRootDir,
|
|
isSandboxed: () => false,
|
|
getFileService: () => new FileDiscoveryService(testRootDir),
|
|
getFileFilteringRespectGitIgnore: () => true,
|
|
getFileFilteringRespectQwenIgnore: () => true,
|
|
getFileFilteringOptions: () => ({
|
|
respectGitIgnore: true,
|
|
respectQwenIgnore: true,
|
|
}),
|
|
getFileSystemService: () => new StandardFileSystemService(),
|
|
getEnableRecursiveFileSearch: vi.fn(() => true),
|
|
getWorkspaceContext: () => ({
|
|
isPathWithinWorkspace: () => true,
|
|
getDirectories: () => [testRootDir],
|
|
}),
|
|
getMcpServers: () => ({}),
|
|
getMcpServerCommand: () => undefined,
|
|
getPromptRegistry: () => ({
|
|
getPromptsByServer: () => [],
|
|
}),
|
|
getDebugMode: () => false,
|
|
getFileExclusions: () => ({
|
|
getCoreIgnorePatterns: () => COMMON_IGNORE_PATTERNS,
|
|
getDefaultExcludePatterns: () => [],
|
|
getGlobExcludes: () => [],
|
|
buildExcludePatterns: () => [],
|
|
getReadManyFilesExcludes: () => [],
|
|
}),
|
|
getUsageStatisticsEnabled: () => false,
|
|
getTruncateToolOutputThreshold: () => 2500,
|
|
getTruncateToolOutputLines: () => 500,
|
|
} as unknown as Config;
|
|
});
|
|
|
|
afterEach(async () => {
|
|
abortController.abort();
|
|
await fsPromises.rm(testRootDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('should pass through query if no @ command is present', async () => {
|
|
const query = 'regular user query';
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 123,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [{ text: query }],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should pass through original query if only a lone @ symbol is present', async () => {
|
|
const queryWithSpaces = ' @ ';
|
|
|
|
const result = await handleAtCommand({
|
|
query: queryWithSpaces,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 124,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [{ text: queryWithSpaces }],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
'Lone @ detected, will be treated as text in the modified query.',
|
|
);
|
|
});
|
|
|
|
it('should process a valid text file path', async () => {
|
|
const fileContent = 'This is the file content.';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'path', 'to', 'file.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `@${filePath}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 125,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result.processedQuery).toEqual([
|
|
{ text: `@${filePath}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
]);
|
|
expect(result.shouldProceed).toBe(true);
|
|
// toolDisplays should be returned for caller to add to UI history
|
|
expect(result.toolDisplays).toBeDefined();
|
|
expect(result.toolDisplays).toHaveLength(1);
|
|
expect(result.toolDisplays![0].status).toBe(ToolCallStatus.Success);
|
|
});
|
|
|
|
it('should process a valid directory path', async () => {
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'path', 'to', 'file.txt'),
|
|
'This is the file content.',
|
|
);
|
|
const dirPath = path.dirname(filePath);
|
|
const query = `@${dirPath}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 126,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
const processedText = Array.isArray(result.processedQuery)
|
|
? result.processedQuery
|
|
.map((part) =>
|
|
typeof part === 'string'
|
|
? part
|
|
: 'text' in part
|
|
? part.text
|
|
: JSON.stringify(part),
|
|
)
|
|
.join('')
|
|
: '';
|
|
|
|
expect(processedText).toContain(`@${dirPath}`);
|
|
expect(processedText).toContain(`Content from ${dirPath}:`);
|
|
expect(processedText).toContain('Showing up to');
|
|
expect(result.shouldProceed).toBe(true);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${dirPath} resolved to directory.`,
|
|
);
|
|
});
|
|
|
|
it('should handle query with text before and after @command', async () => {
|
|
const fileContent = 'Markdown content.';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'doc.md'),
|
|
fileContent,
|
|
);
|
|
const textBefore = 'Explain this: ';
|
|
const textAfter = ' in detail.';
|
|
const query = `${textBefore}@${filePath}${textAfter}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 128,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `${textBefore}@${filePath}${textAfter}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should correctly unescape paths with escaped spaces', async () => {
|
|
const fileContent = 'This is the file content.';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'path', 'to', 'my file.txt'),
|
|
fileContent,
|
|
);
|
|
const escapedpath = path.join(testRootDir, 'path', 'to', 'my\\ file.txt');
|
|
const query = `@${escapedpath}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 125,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result.processedQuery).toEqual([
|
|
{ text: `@${filePath}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
]);
|
|
expect(result.shouldProceed).toBe(true);
|
|
// toolDisplays should be returned for caller to add to UI history
|
|
expect(result.toolDisplays).toBeDefined();
|
|
expect(result.toolDisplays).toHaveLength(1);
|
|
expect(result.toolDisplays![0].status).toBe(ToolCallStatus.Success);
|
|
});
|
|
|
|
it('should handle multiple @file references', async () => {
|
|
const content1 = 'Content file1';
|
|
const file1Path = await createTestFile(
|
|
path.join(testRootDir, 'file1.txt'),
|
|
content1,
|
|
);
|
|
const content2 = 'Content file2';
|
|
const file2Path = await createTestFile(
|
|
path.join(testRootDir, 'file2.md'),
|
|
content2,
|
|
);
|
|
const query = `@${file1Path} @${file2Path}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 130,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: query },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${file1Path}:\n` },
|
|
{ text: content1 },
|
|
{ text: `\nContent from ${file2Path}:\n` },
|
|
{ text: content2 },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle multiple @file references with interleaved text', async () => {
|
|
const text1 = 'Check ';
|
|
const content1 = 'C1';
|
|
const file1Path = await createTestFile(
|
|
path.join(testRootDir, 'f1.txt'),
|
|
content1,
|
|
);
|
|
const text2 = ' and ';
|
|
const content2 = 'C2';
|
|
const file2Path = await createTestFile(
|
|
path.join(testRootDir, 'f2.md'),
|
|
content2,
|
|
);
|
|
const text3 = ' please.';
|
|
const query = `${text1}@${file1Path}${text2}@${file2Path}${text3}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 131,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: query },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${file1Path}:\n` },
|
|
{ text: content1 },
|
|
{ text: `\nContent from ${file2Path}:\n` },
|
|
{ text: content2 },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle a mix of valid, invalid, and lone @ references', async () => {
|
|
const content1 = 'Valid content 1';
|
|
const file1Path = await createTestFile(
|
|
path.join(testRootDir, 'valid1.txt'),
|
|
content1,
|
|
);
|
|
const invalidFile = 'nonexistent.txt';
|
|
const content2 = 'Globbed content';
|
|
const file2Path = await createTestFile(
|
|
path.join(testRootDir, 'resolved', 'valid2.actual'),
|
|
content2,
|
|
);
|
|
const query = `Look at @${file1Path} then @${invalidFile} and also just @ symbol, then @${file2Path}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 132,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{
|
|
text: `Look at @${file1Path} then @${invalidFile} and also just @ symbol, then @${file2Path}`,
|
|
},
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${file1Path}:\n` },
|
|
{ text: content1 },
|
|
{ text: `\nContent from ${file2Path}:\n` },
|
|
{ text: content2 },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${invalidFile} not found. Path ${invalidFile} will be skipped.`,
|
|
);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
'Lone @ detected, will be treated as text in the modified query.',
|
|
);
|
|
});
|
|
|
|
it('should return original query if all @paths are invalid or lone @', async () => {
|
|
const query = 'Check @nonexistent.txt and @ also';
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 133,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [{ text: 'Check @nonexistent.txt and @ also' }],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
describe('git-aware filtering', () => {
|
|
beforeEach(async () => {
|
|
await fsPromises.mkdir(path.join(testRootDir, '.git'), {
|
|
recursive: true,
|
|
});
|
|
});
|
|
|
|
it('should skip git-ignored files in @ commands', async () => {
|
|
await createTestFile(
|
|
path.join(testRootDir, '.gitignore'),
|
|
'node_modules/package.json',
|
|
);
|
|
const gitIgnoredFile = await createTestFile(
|
|
path.join(testRootDir, 'node_modules', 'package.json'),
|
|
'the file contents',
|
|
);
|
|
|
|
const query = `@${gitIgnoredFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 200,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [{ text: query }],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${gitIgnoredFile} is git-ignored and will be skipped.`,
|
|
);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Ignored 1 files:\nGit-ignored: ${gitIgnoredFile}`,
|
|
);
|
|
});
|
|
|
|
it('should process non-git-ignored files normally', async () => {
|
|
await createTestFile(
|
|
path.join(testRootDir, '.gitignore'),
|
|
'node_modules/package.json',
|
|
);
|
|
|
|
const validFile = await createTestFile(
|
|
path.join(testRootDir, 'src', 'index.ts'),
|
|
'console.log("Hello world");',
|
|
);
|
|
const query = `@${validFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 201,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `@${validFile}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${validFile}:\n` },
|
|
{ text: 'console.log("Hello world");' },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle mixed git-ignored and valid files', async () => {
|
|
await createTestFile(path.join(testRootDir, '.gitignore'), '.env');
|
|
const validFile = await createTestFile(
|
|
path.join(testRootDir, 'README.md'),
|
|
'# Project README',
|
|
);
|
|
const gitIgnoredFile = await createTestFile(
|
|
path.join(testRootDir, '.env'),
|
|
'SECRET=123',
|
|
);
|
|
const query = `@${validFile} @${gitIgnoredFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 202,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `@${validFile} @${gitIgnoredFile}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${validFile}:\n` },
|
|
{ text: '# Project README' },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${gitIgnoredFile} is git-ignored and will be skipped.`,
|
|
);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Ignored 1 files:\nGit-ignored: ${gitIgnoredFile}`,
|
|
);
|
|
});
|
|
|
|
it('should always ignore .git directory files', async () => {
|
|
const gitFile = await createTestFile(
|
|
path.join(testRootDir, '.git', 'config'),
|
|
'[core]\n\trepositoryformatversion = 0\n',
|
|
);
|
|
const query = `@${gitFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 203,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [{ text: query }],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${gitFile} is git-ignored and will be skipped.`,
|
|
);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Ignored 1 files:\nGit-ignored: ${gitFile}`,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('qwen-ignore filtering', () => {
|
|
it('should skip qwen-ignored files in @ commands', async () => {
|
|
await createTestFile(
|
|
path.join(testRootDir, '.qwenignore'),
|
|
'build/output.js',
|
|
);
|
|
const qwenIgnoredFile = await createTestFile(
|
|
path.join(testRootDir, 'build', 'output.js'),
|
|
'console.log("Hello");',
|
|
);
|
|
const query = `@${qwenIgnoredFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 204,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [{ text: query }],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${qwenIgnoredFile} is qwen-ignored and will be skipped.`,
|
|
);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Ignored 1 files:\nQwen-ignored: ${qwenIgnoredFile}`,
|
|
);
|
|
});
|
|
});
|
|
it('should process non-ignored files when .qwenignore is present', async () => {
|
|
await createTestFile(
|
|
path.join(testRootDir, '.qwenignore'),
|
|
'build/output.js',
|
|
);
|
|
const validFile = await createTestFile(
|
|
path.join(testRootDir, 'src', 'index.ts'),
|
|
'console.log("Hello world");',
|
|
);
|
|
const query = `@${validFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 205,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `@${validFile}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${validFile}:\n` },
|
|
{ text: 'console.log("Hello world");' },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle mixed qwen-ignored and valid files', async () => {
|
|
await createTestFile(
|
|
path.join(testRootDir, '.qwenignore'),
|
|
'dist/bundle.js',
|
|
);
|
|
const validFile = await createTestFile(
|
|
path.join(testRootDir, 'src', 'main.ts'),
|
|
'// Main application entry',
|
|
);
|
|
const qwenIgnoredFile = await createTestFile(
|
|
path.join(testRootDir, 'dist', 'bundle.js'),
|
|
'console.log("bundle");',
|
|
);
|
|
const query = `@${validFile} @${qwenIgnoredFile}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 206,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `@${validFile} @${qwenIgnoredFile}` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${validFile}:\n` },
|
|
{ text: '// Main application entry' },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Path ${qwenIgnoredFile} is qwen-ignored and will be skipped.`,
|
|
);
|
|
expect(mockOnDebugMessage).toHaveBeenCalledWith(
|
|
`Ignored 1 files:\nQwen-ignored: ${qwenIgnoredFile}`,
|
|
);
|
|
});
|
|
|
|
describe('punctuation termination in @ commands', () => {
|
|
const punctuationTestCases = [
|
|
{
|
|
name: 'comma',
|
|
fileName: 'test.txt',
|
|
fileContent: 'File content here',
|
|
queryTemplate: (filePath: string) =>
|
|
`Look at @${filePath}, then explain it.`,
|
|
messageId: 400,
|
|
},
|
|
{
|
|
name: 'period',
|
|
fileName: 'readme.md',
|
|
fileContent: 'File content here',
|
|
queryTemplate: (filePath: string) =>
|
|
`Check @${filePath}. What does it say?`,
|
|
messageId: 401,
|
|
},
|
|
{
|
|
name: 'semicolon',
|
|
fileName: 'example.js',
|
|
fileContent: 'Code example',
|
|
queryTemplate: (filePath: string) =>
|
|
`Review @${filePath}; check for bugs.`,
|
|
messageId: 402,
|
|
},
|
|
{
|
|
name: 'exclamation mark',
|
|
fileName: 'important.txt',
|
|
fileContent: 'Important content',
|
|
queryTemplate: (filePath: string) =>
|
|
`Look at @${filePath}! This is critical.`,
|
|
messageId: 403,
|
|
},
|
|
{
|
|
name: 'question mark',
|
|
fileName: 'config.json',
|
|
fileContent: 'Config settings',
|
|
queryTemplate: (filePath: string) =>
|
|
`What is in @${filePath}? Please explain.`,
|
|
messageId: 404,
|
|
},
|
|
{
|
|
name: 'opening parenthesis',
|
|
fileName: 'func.ts',
|
|
fileContent: 'Function definition',
|
|
queryTemplate: (filePath: string) =>
|
|
`Analyze @${filePath}(the main function).`,
|
|
messageId: 405,
|
|
},
|
|
{
|
|
name: 'closing parenthesis',
|
|
fileName: 'data.json',
|
|
fileContent: 'Test data',
|
|
queryTemplate: (filePath: string) =>
|
|
`Use data from @${filePath}) for testing.`,
|
|
messageId: 406,
|
|
},
|
|
{
|
|
name: 'opening square bracket',
|
|
fileName: 'array.js',
|
|
fileContent: 'Array data',
|
|
queryTemplate: (filePath: string) =>
|
|
`Check @${filePath}[0] for the first element.`,
|
|
messageId: 407,
|
|
},
|
|
{
|
|
name: 'closing square bracket',
|
|
fileName: 'list.md',
|
|
fileContent: 'List content',
|
|
queryTemplate: (filePath: string) =>
|
|
`Review item @${filePath}] from the list.`,
|
|
messageId: 408,
|
|
},
|
|
{
|
|
name: 'opening curly brace',
|
|
fileName: 'object.ts',
|
|
fileContent: 'Object definition',
|
|
queryTemplate: (filePath: string) =>
|
|
`Parse @${filePath}{prop1: value1}.`,
|
|
messageId: 409,
|
|
},
|
|
{
|
|
name: 'closing curly brace',
|
|
fileName: 'config.yaml',
|
|
fileContent: 'Configuration',
|
|
queryTemplate: (filePath: string) =>
|
|
`Use settings from @${filePath}} for deployment.`,
|
|
messageId: 410,
|
|
},
|
|
];
|
|
|
|
it.each(punctuationTestCases)(
|
|
'should terminate @path at $name',
|
|
async ({ fileName, fileContent, queryTemplate, messageId }) => {
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, fileName),
|
|
fileContent,
|
|
);
|
|
const query = queryTemplate(filePath);
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: query },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
},
|
|
);
|
|
|
|
it('should handle multiple @paths terminated by different punctuation', async () => {
|
|
const content1 = 'First file';
|
|
const file1Path = await createTestFile(
|
|
path.join(testRootDir, 'first.txt'),
|
|
content1,
|
|
);
|
|
const content2 = 'Second file';
|
|
const file2Path = await createTestFile(
|
|
path.join(testRootDir, 'second.txt'),
|
|
content2,
|
|
);
|
|
const query = `Compare @${file1Path}, @${file2Path}; what's different?`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 411,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Compare @${file1Path}, @${file2Path}; what's different?` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${file1Path}:\n` },
|
|
{ text: content1 },
|
|
{ text: `\nContent from ${file2Path}:\n` },
|
|
{ text: content2 },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should still handle escaped spaces in paths before punctuation', async () => {
|
|
const fileContent = 'Spaced file content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'spaced file.txt'),
|
|
fileContent,
|
|
);
|
|
const escapedPath = path.join(testRootDir, 'spaced\\ file.txt');
|
|
const query = `Check @${escapedPath}, it has spaces.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 412,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Check @${filePath}, it has spaces.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should not break file paths with periods in extensions', async () => {
|
|
const fileContent = 'TypeScript content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'example.d.ts'),
|
|
fileContent,
|
|
);
|
|
const query = `Analyze @${filePath} for type definitions.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 413,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Analyze @${filePath} for type definitions.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle file paths ending with period followed by space', async () => {
|
|
const fileContent = 'Config content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'config.json'),
|
|
fileContent,
|
|
);
|
|
const query = `Check @${filePath}. This file contains settings.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 414,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Check @${filePath}. This file contains settings.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle comma termination with complex file paths', async () => {
|
|
const fileContent = 'Package info';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'package.json'),
|
|
fileContent,
|
|
);
|
|
const query = `Review @${filePath}, then check dependencies.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 415,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Review @${filePath}, then check dependencies.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should not terminate at period within file name', async () => {
|
|
const fileContent = 'Version info';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'version.1.2.3.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `Check @${filePath} contains version information.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 416,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Check @${filePath} contains version information.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle end of string termination for period and comma', async () => {
|
|
const fileContent = 'End file content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'end.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `Show me @${filePath}.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 417,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Show me @${filePath}.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle files with special characters in names', async () => {
|
|
const fileContent = 'File with special chars content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'file$with&special#chars.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `Check @${filePath} for content.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 418,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Check @${filePath} for content.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
|
|
it('should handle basic file names without special characters', async () => {
|
|
const fileContent = 'Basic file content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'basicfile.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `Check @${filePath} please.`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 421,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result).toMatchObject({
|
|
processedQuery: [
|
|
{ text: `Check @${filePath} please.` },
|
|
{ text: '\n--- Content from referenced files ---' },
|
|
{ text: `\nContent from ${filePath}:\n` },
|
|
{ text: fileContent },
|
|
{ text: '\n--- End of content ---' },
|
|
],
|
|
shouldProceed: true,
|
|
});
|
|
});
|
|
});
|
|
|
|
it("should not add any items to history, as that is the caller's responsibility", async () => {
|
|
// Arrange
|
|
const fileContent = 'This is the file content.';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'path', 'to', 'another-file.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `A query with @${filePath}`;
|
|
|
|
// Act
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 999,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
// Assert
|
|
// handleAtCommand should NOT call addItem at all - it returns data for caller to add
|
|
expect(mockAddItem).not.toHaveBeenCalled();
|
|
|
|
// Instead, it returns toolDisplays for the caller to add to UI history
|
|
expect(result.toolDisplays).toBeDefined();
|
|
expect(result.toolDisplays!.length).toBeGreaterThan(0);
|
|
});
|
|
|
|
describe('chat recording', () => {
|
|
it('should return tool result info for each file read', async () => {
|
|
const content1 = 'Content file1';
|
|
const file1Path = await createTestFile(
|
|
path.join(testRootDir, 'file1.txt'),
|
|
content1,
|
|
);
|
|
const content2 = 'Content file2';
|
|
const file2Path = await createTestFile(
|
|
path.join(testRootDir, 'file2.txt'),
|
|
content2,
|
|
);
|
|
const query = `@${file1Path} @${file2Path}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 500,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
// Should return toolDisplays (one summary for all files)
|
|
expect(result.toolDisplays).toBeDefined();
|
|
expect(result.toolDisplays!.length).toBeGreaterThanOrEqual(1);
|
|
});
|
|
|
|
it('should return toolDisplays for UI and function parts in processedQuery', async () => {
|
|
const fileContent = 'Test content';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'test.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `@${filePath}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 501,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
// Should return toolDisplays for UI
|
|
expect(result.toolDisplays).toBeDefined();
|
|
expect(result.toolDisplays!.length).toBeGreaterThanOrEqual(1);
|
|
|
|
// processedQuery should include file content sections
|
|
expect(result.processedQuery).toBeDefined();
|
|
const parts = Array.isArray(result.processedQuery)
|
|
? result.processedQuery
|
|
: [result.processedQuery];
|
|
const flattened = parts
|
|
.map((part) =>
|
|
typeof part === 'string'
|
|
? part
|
|
: (part as { text?: string }).text || '',
|
|
)
|
|
.join('');
|
|
expect(flattened).toContain('Content from ');
|
|
expect(flattened).toContain(fileContent);
|
|
});
|
|
|
|
it('should not return tool result infos when no files are read', async () => {
|
|
const query = 'query without any @ commands';
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 502,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result.toolDisplays).toBeUndefined();
|
|
});
|
|
|
|
it('should include file path in tool display result', async () => {
|
|
const fileContent = 'File content here';
|
|
const filePath = await createTestFile(
|
|
path.join(testRootDir, 'specific-file.txt'),
|
|
fileContent,
|
|
);
|
|
const query = `@${filePath}`;
|
|
|
|
const result = await handleAtCommand({
|
|
query,
|
|
config: mockConfig,
|
|
onDebugMessage: mockOnDebugMessage,
|
|
messageId: 503,
|
|
signal: abortController.signal,
|
|
});
|
|
|
|
expect(result.toolDisplays).toBeDefined();
|
|
expect(result.toolDisplays!.length).toBeGreaterThanOrEqual(1);
|
|
expect(result.toolDisplays![0].description).toContain('file.txt');
|
|
});
|
|
});
|
|
});
|