fix: add runtime indexing state check to codebase_search tool (#5662)

[MuriloFP]

Related GitHub Issue

Closes: #5662

Roo Code Task Context (Optional)

No Roo Code task context for this PR

Description

This PR implements a runtime check for the indexing state in the codebase_search tool, as suggested by @daniel-lxs in the issue comments. Instead of hiding the tool from the tool list when indexing is not complete (as attempted in PR #5663), this solution:

• Keeps the codebase_search tool always available in the tool list
• Performs a runtime check when the tool is actually used
• Provides a clear, informative error message when indexing is not complete
• Guides users to use alternative tools (read_file, search_files) while indexing is in progress

The key implementation detail is the addition of a state check before executing the search:

if (indexingState !== 'Indexed') {
    throw new Error(`Semantic search isn't ready yet (currently ${indexingState}). The codebase is still being indexed. Please try again once indexing is complete, or use other tools like read_file or search_files for now.`)
}

This approach provides better user experience by:

1. Making state transitions smoother (e.g., when indexing finishes mid-conversation)
2. Keeping the logic in one place (inside the tool)
3. Helping users understand why semantic search isn't available instead of silently hiding it

Test Procedure

Unit Tests:

• Created comprehensive test suite in src/core/tools/__tests__/codebaseSearchTool.spec.ts
• Tests cover all indexing states: 'Standby', 'Indexing', 'Error', and 'Indexed'
• Tests verify the error messages are shown correctly for non-'Indexed' states
• All 10 new tests pass
• All existing tests continue to pass (238 test files, 2906 tests)

Manual Testing Steps:

1. Disable code indexing in settings and try to use codebase_search - should get "disabled" error
2. Enable indexing but don't configure (missing API key) - should get "not configured" error
3. Start indexing and immediately try to use codebase_search - should get "currently Indexing" error
4. Wait for indexing to complete and use codebase_search - should work normally

To run the tests:

cd src && npx vitest core/tools/__tests__/codebaseSearchTool.spec.ts

Pre-Submission Checklist

• Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
• Scope: My changes are focused on the linked issue (one major feature/fix per PR).
• Self-Review: I have performed a thorough self-review of my code.
• Testing: New and/or updated tests have been added to cover my changes (if applicable).
• Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
• Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Screenshots / Videos

No UI changes in this PR

Documentation Updates

• No documentation updates are required.

Additional Notes

This implementation follows the suggestion from @daniel-lxs in the issue comments, which provides a better user experience than the approach in PR #5663. The error messages are designed to be informative and guide users to alternative solutions while waiting for indexing to complete.

Get in Touch

Discord username not provided

---

Important

Adds runtime indexing state check to codebaseSearchTool and comprehensive tests for various states and configurations.

• Behavior:
  • Adds runtime check in codebaseSearchTool to ensure indexing state is 'Indexed' before proceeding.
  • Throws error with informative message if indexing state is 'Indexing', 'Standby', or 'Error'.
  • Keeps codebase_search tool available in tool list regardless of indexing state.
• Tests:
  • Adds codebaseSearchTool.spec.ts with tests for indexing states: 'Standby', 'Indexing', 'Error', and 'Indexed'.
  • Tests for feature availability: disabled and not configured states.
  • Tests for parameter validation and search results handling.
• Misc:
  • Guides users to alternative tools if indexing is incomplete.

^{This description was created by for 8bd4fc5. You can customize this summary. It will automatically update as commits are pushed.}

[daniel-lxs]

LGTM

[daniel-lxs]

I think this should be handled differently.

We should distinguish between the initial full-codebase scan and the file watcher indexing state. That way, file changes don’t end up disabling the tool.

If indexing is enabled but not ready, we should show a warning to the user. The tool should also be excluded from the system prompt until it's fully ready.