Implements updateTask command to update a single task instead of all tasks as of a certain one. Useful when iterating and R&D'ing bit by bit and needing more research after what has been done.
This commit is contained in:
Eyal Toledano
@@ -6,6 +6,11 @@ import { jest } from '@jest/globals';
|
||||
|
||||
// Mock functions that need jest.fn methods
|
||||
const mockParsePRD = jest.fn().mockResolvedValue(undefined);
|
||||
const mockUpdateTaskById = jest.fn().mockResolvedValue({
|
||||
id: 2,
|
||||
title: 'Updated Task',
|
||||
description: 'Updated description'
|
||||
});
|
||||
const mockDisplayBanner = jest.fn();
|
||||
const mockDisplayHelp = jest.fn();
|
||||
const mockLog = jest.fn();
|
||||
@@ -37,7 +42,8 @@ jest.mock('../../scripts/modules/ui.js', () => ({
|
||||
}));
|
||||
|
||||
jest.mock('../../scripts/modules/task-manager.js', () => ({
|
||||
parsePRD: mockParsePRD
|
||||
parsePRD: mockParsePRD,
|
||||
updateTaskById: mockUpdateTaskById
|
||||
}));
|
||||
|
||||
// Add this function before the mock of utils.js
|
||||
@@ -286,4 +292,238 @@ describe('Commands Module', () => {
|
||||
expect(mockParsePRD).toHaveBeenCalledWith(testFile, outputFile, numTasks);
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateTask command', () => {
|
||||
// Since mocking Commander is complex, we'll test the action handler directly
|
||||
// Recreate the action handler logic based on commands.js
|
||||
async function updateTaskAction(options) {
|
||||
try {
|
||||
const tasksPath = options.file;
|
||||
|
||||
// Validate required parameters
|
||||
if (!options.id) {
|
||||
console.error(chalk.red('Error: --id parameter is required'));
|
||||
console.log(chalk.yellow('Usage example: task-master update-task --id=23 --prompt="Update with new information"'));
|
||||
process.exit(1);
|
||||
return; // Add early return to prevent calling updateTaskById
|
||||
}
|
||||
|
||||
// Parse the task ID and validate it's a number
|
||||
const taskId = parseInt(options.id, 10);
|
||||
if (isNaN(taskId) || taskId <= 0) {
|
||||
console.error(chalk.red(`Error: Invalid task ID: ${options.id}. Task ID must be a positive integer.`));
|
||||
console.log(chalk.yellow('Usage example: task-master update-task --id=23 --prompt="Update with new information"'));
|
||||
process.exit(1);
|
||||
return; // Add early return to prevent calling updateTaskById
|
||||
}
|
||||
|
||||
if (!options.prompt) {
|
||||
console.error(chalk.red('Error: --prompt parameter is required. Please provide information about the changes.'));
|
||||
console.log(chalk.yellow('Usage example: task-master update-task --id=23 --prompt="Update with new information"'));
|
||||
process.exit(1);
|
||||
return; // Add early return to prevent calling updateTaskById
|
||||
}
|
||||
|
||||
const prompt = options.prompt;
|
||||
const useResearch = options.research || false;
|
||||
|
||||
// Validate tasks file exists
|
||||
if (!fs.existsSync(tasksPath)) {
|
||||
console.error(chalk.red(`Error: Tasks file not found at path: ${tasksPath}`));
|
||||
if (tasksPath === 'tasks/tasks.json') {
|
||||
console.log(chalk.yellow('Hint: Run task-master init or task-master parse-prd to create tasks.json first'));
|
||||
} else {
|
||||
console.log(chalk.yellow(`Hint: Check if the file path is correct: ${tasksPath}`));
|
||||
}
|
||||
process.exit(1);
|
||||
return; // Add early return to prevent calling updateTaskById
|
||||
}
|
||||
|
||||
console.log(chalk.blue(`Updating task ${taskId} with prompt: "${prompt}"`));
|
||||
console.log(chalk.blue(`Tasks file: ${tasksPath}`));
|
||||
|
||||
if (useResearch) {
|
||||
// Verify Perplexity API key exists if using research
|
||||
if (!process.env.PERPLEXITY_API_KEY) {
|
||||
console.log(chalk.yellow('Warning: PERPLEXITY_API_KEY environment variable is missing. Research-backed updates will not be available.'));
|
||||
console.log(chalk.yellow('Falling back to Claude AI for task update.'));
|
||||
} else {
|
||||
console.log(chalk.blue('Using Perplexity AI for research-backed task update'));
|
||||
}
|
||||
}
|
||||
|
||||
const result = await mockUpdateTaskById(tasksPath, taskId, prompt, useResearch);
|
||||
|
||||
// If the task wasn't updated (e.g., if it was already marked as done)
|
||||
if (!result) {
|
||||
console.log(chalk.yellow('\nTask update was not completed. Review the messages above for details.'));
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(chalk.red(`Error: ${error.message}`));
|
||||
|
||||
// Provide more helpful error messages for common issues
|
||||
if (error.message.includes('task') && error.message.includes('not found')) {
|
||||
console.log(chalk.yellow('\nTo fix this issue:'));
|
||||
console.log(' 1. Run task-master list to see all available task IDs');
|
||||
console.log(' 2. Use a valid task ID with the --id parameter');
|
||||
} else if (error.message.includes('API key')) {
|
||||
console.log(chalk.yellow('\nThis error is related to API keys. Check your environment variables.'));
|
||||
}
|
||||
|
||||
if (true) { // CONFIG.debug
|
||||
console.error(error);
|
||||
}
|
||||
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
// Reset all mocks
|
||||
jest.clearAllMocks();
|
||||
|
||||
// Set up spy for existsSync (already mocked in the outer scope)
|
||||
mockExistsSync.mockReturnValue(true);
|
||||
});
|
||||
|
||||
test('should validate required parameters - missing ID', async () => {
|
||||
// Set up the command options without ID
|
||||
const options = {
|
||||
file: 'test-tasks.json',
|
||||
prompt: 'Update the task'
|
||||
};
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify validation error
|
||||
expect(mockConsoleError).toHaveBeenCalledWith(expect.stringContaining('--id parameter is required'));
|
||||
expect(mockExit).toHaveBeenCalledWith(1);
|
||||
expect(mockUpdateTaskById).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test('should validate required parameters - invalid ID', async () => {
|
||||
// Set up the command options with invalid ID
|
||||
const options = {
|
||||
file: 'test-tasks.json',
|
||||
id: 'not-a-number',
|
||||
prompt: 'Update the task'
|
||||
};
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify validation error
|
||||
expect(mockConsoleError).toHaveBeenCalledWith(expect.stringContaining('Invalid task ID'));
|
||||
expect(mockExit).toHaveBeenCalledWith(1);
|
||||
expect(mockUpdateTaskById).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test('should validate required parameters - missing prompt', async () => {
|
||||
// Set up the command options without prompt
|
||||
const options = {
|
||||
file: 'test-tasks.json',
|
||||
id: '2'
|
||||
};
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify validation error
|
||||
expect(mockConsoleError).toHaveBeenCalledWith(expect.stringContaining('--prompt parameter is required'));
|
||||
expect(mockExit).toHaveBeenCalledWith(1);
|
||||
expect(mockUpdateTaskById).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test('should validate tasks file exists', async () => {
|
||||
// Mock file not existing
|
||||
mockExistsSync.mockReturnValue(false);
|
||||
|
||||
// Set up the command options
|
||||
const options = {
|
||||
file: 'missing-tasks.json',
|
||||
id: '2',
|
||||
prompt: 'Update the task'
|
||||
};
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify validation error
|
||||
expect(mockConsoleError).toHaveBeenCalledWith(expect.stringContaining('Tasks file not found'));
|
||||
expect(mockExit).toHaveBeenCalledWith(1);
|
||||
expect(mockUpdateTaskById).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test('should call updateTaskById with correct parameters', async () => {
|
||||
// Set up the command options
|
||||
const options = {
|
||||
file: 'test-tasks.json',
|
||||
id: '2',
|
||||
prompt: 'Update the task',
|
||||
research: true
|
||||
};
|
||||
|
||||
// Mock perplexity API key
|
||||
process.env.PERPLEXITY_API_KEY = 'dummy-key';
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify updateTaskById was called with correct parameters
|
||||
expect(mockUpdateTaskById).toHaveBeenCalledWith(
|
||||
'test-tasks.json',
|
||||
2,
|
||||
'Update the task',
|
||||
true
|
||||
);
|
||||
|
||||
// Verify console output
|
||||
expect(mockConsoleLog).toHaveBeenCalledWith(expect.stringContaining('Updating task 2'));
|
||||
expect(mockConsoleLog).toHaveBeenCalledWith(expect.stringContaining('Using Perplexity AI'));
|
||||
|
||||
// Clean up
|
||||
delete process.env.PERPLEXITY_API_KEY;
|
||||
});
|
||||
|
||||
test('should handle null result from updateTaskById', async () => {
|
||||
// Mock updateTaskById returning null (e.g., task already completed)
|
||||
mockUpdateTaskById.mockResolvedValueOnce(null);
|
||||
|
||||
// Set up the command options
|
||||
const options = {
|
||||
file: 'test-tasks.json',
|
||||
id: '2',
|
||||
prompt: 'Update the task'
|
||||
};
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify updateTaskById was called
|
||||
expect(mockUpdateTaskById).toHaveBeenCalled();
|
||||
|
||||
// Verify console output for null result
|
||||
expect(mockConsoleLog).toHaveBeenCalledWith(expect.stringContaining('Task update was not completed'));
|
||||
});
|
||||
|
||||
test('should handle errors from updateTaskById', async () => {
|
||||
// Mock updateTaskById throwing an error
|
||||
mockUpdateTaskById.mockRejectedValueOnce(new Error('Task update failed'));
|
||||
|
||||
// Set up the command options
|
||||
const options = {
|
||||
file: 'test-tasks.json',
|
||||
id: '2',
|
||||
prompt: 'Update the task'
|
||||
};
|
||||
|
||||
// Call the action directly
|
||||
await updateTaskAction(options);
|
||||
|
||||
// Verify error handling
|
||||
expect(mockConsoleError).toHaveBeenCalledWith(expect.stringContaining('Error: Task update failed'));
|
||||
expect(mockExit).toHaveBeenCalledWith(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user