Search scope refactor #405
Conversation
This comment has been minimized.
This comment has been minimized.
WalkthroughThis change refactors the chat and search context selection system throughout the application. It unifies the previously separate handling of selected repositories and contexts into a single "selectedSearchScopes" array, updates all related types, schemas, and UI components, and introduces new informational components and icons to support the new model. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI_Components
participant API_Server
participant Agent
User->>UI_Components: Select one or more search scopes
UI_Components->>API_Server: Send message with selectedSearchScopes[]
API_Server->>Agent: Expand searchScopeRepoNames from selectedSearchScopes
Agent-->>API_Server: Analyze and respond using provided repo names
API_Server-->>UI_Components: Stream response with metadata (selectedSearchScopes)
UI_Components-->>User: Display response, show selected search scopes in UI
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/web/src/components/searchScopeInfoCard.tsx (1)
17-30: Consider extracting the icon rendering logic for better readability.The IIFE (Immediately Invoked Function Expression) works correctly but could be more readable as a separate function or component.
Consider extracting this logic:
const renderRepositoryIcon = () => { const githubIcon = getCodeHostIcon("github"); return githubIcon ? ( <Image src={githubIcon.src} alt="GitHub icon" width={16} height={16} className={cn("h-4 w-4 flex-shrink-0", githubIcon.className)} /> ) : ( <Code className="h-4 w-4 text-muted-foreground flex-shrink-0" /> ); };Then use:
{renderRepositoryIcon()}packages/web/src/features/chat/components/searchScopeIcon.tsx (1)
11-32: Well-implemented icon component with good fallback handling.The component properly handles different search scope types and provides appropriate fallbacks. The logic flow is clear and the icon selection makes sense.
Consider making the size calculation more robust:
- const size = className.includes('h-3') ? 12 : 16; + const size = className.match(/\bh-3\b/) ? 12 : 16;This uses a word boundary regex to avoid false matches when 'h-3' appears as part of another class name.
packages/web/src/app/[domain]/components/homepage/askSourcebotDemoCards.tsx (1)
35-66: Icon function logic is correct with a minor suggestion.The function properly handles different search scope types and selection states. The icon inversion logic for selected badges is complex but necessary for proper contrast.
Consider extracting the size calculation to improve readability:
const getSearchScopeIcon = (searchScope: DemoSearchScope, size: number = 20, isSelected: boolean = false) => { - const sizeClass = size === 12 ? "h-3 w-3" : "h-5 w-5"; + const sizeClass = `h-${size === 12 ? '3' : '5'} w-${size === 12 ? '3' : '5'}`; const colorClass = isSelected ? "text-primary-foreground" : "text-muted-foreground";
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
packages/web/src/app/[domain]/chat/[id]/components/chatThreadPanel.tsx(4 hunks)packages/web/src/app/[domain]/chat/components/newChatPanel.tsx(4 hunks)packages/web/src/app/[domain]/components/homepage/agenticSearch.tsx(3 hunks)packages/web/src/app/[domain]/components/homepage/askSourcebotDemoCards.tsx(3 hunks)packages/web/src/app/api/(server)/chat/route.ts(5 hunks)packages/web/src/components/atMentionInfoCard.tsx(1 hunks)packages/web/src/components/searchScopeInfoCard.tsx(1 hunks)packages/web/src/features/chat/agent.ts(5 hunks)packages/web/src/features/chat/components/chatBox/chatBox.tsx(8 hunks)packages/web/src/features/chat/components/chatBox/chatBoxToolbar.tsx(3 hunks)packages/web/src/features/chat/components/chatBox/searchScopeSelector.tsx(8 hunks)packages/web/src/features/chat/components/chatThread/chatThread.tsx(7 hunks)packages/web/src/features/chat/components/chatThread/detailsCard.tsx(2 hunks)packages/web/src/features/chat/components/searchScopeIcon.tsx(1 hunks)packages/web/src/features/chat/types.ts(4 hunks)packages/web/src/features/chat/useCreateNewChatThread.ts(2 hunks)packages/web/src/features/chat/utils.ts(3 hunks)packages/web/src/types.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
📄 CodeRabbit Inference Engine (.cursor/rules/style.mdc)
Filenames should always be camelCase. Exception: if there are filenames in the same directory with a format other than camelCase, use that format to keep things consistent.
Files:
packages/web/src/features/chat/components/chatThread/detailsCard.tsxpackages/web/src/features/chat/utils.tspackages/web/src/app/[domain]/chat/[id]/components/chatThreadPanel.tsxpackages/web/src/components/atMentionInfoCard.tsxpackages/web/src/features/chat/components/chatThread/chatThread.tsxpackages/web/src/features/chat/components/chatBox/chatBoxToolbar.tsxpackages/web/src/components/searchScopeInfoCard.tsxpackages/web/src/features/chat/agent.tspackages/web/src/app/api/(server)/chat/route.tspackages/web/src/features/chat/useCreateNewChatThread.tspackages/web/src/app/[domain]/chat/components/newChatPanel.tsxpackages/web/src/types.tspackages/web/src/features/chat/components/searchScopeIcon.tsxpackages/web/src/app/[domain]/components/homepage/agenticSearch.tsxpackages/web/src/features/chat/components/chatBox/chatBox.tsxpackages/web/src/features/chat/components/chatBox/searchScopeSelector.tsxpackages/web/src/app/[domain]/components/homepage/askSourcebotDemoCards.tsxpackages/web/src/features/chat/types.ts
🧬 Code Graph Analysis (11)
packages/web/src/features/chat/components/chatThread/detailsCard.tsx (2)
packages/web/src/components/ui/tooltip.tsx (3)
Tooltip(30-30)TooltipTrigger(30-30)TooltipContent(30-30)packages/web/src/features/chat/components/searchScopeIcon.tsx (1)
SearchScopeIcon(11-32)
packages/web/src/features/chat/utils.ts (1)
packages/web/src/features/chat/types.ts (3)
MentionData(124-124)SearchScope(62-62)SBChatMessage(94-98)
packages/web/src/app/[domain]/chat/[id]/components/chatThreadPanel.tsx (1)
packages/web/src/features/chat/types.ts (3)
SearchScope(62-62)SET_CHAT_STATE_QUERY_PARAM(159-159)SetChatStatePayload(161-164)
packages/web/src/features/chat/components/chatBox/chatBoxToolbar.tsx (3)
packages/web/src/components/atMentionInfoCard.tsx (1)
AtMentionInfoCard(3-15)packages/web/src/features/chat/components/chatBox/searchScopeSelector.tsx (1)
SearchScopeSelector(41-243)packages/web/src/components/searchScopeInfoCard.tsx (1)
SearchScopeInfoCard(5-41)
packages/web/src/components/searchScopeInfoCard.tsx (1)
packages/web/src/lib/utils.ts (2)
getCodeHostIcon(272-303)cn(20-22)
packages/web/src/features/chat/agent.ts (1)
packages/web/src/features/chat/tools.ts (1)
createCodeSearchTool(138-177)
packages/web/src/features/chat/useCreateNewChatThread.ts (3)
packages/web/src/components/hooks/use-toast.ts (1)
useToast(194-194)packages/web/src/features/chat/types.ts (1)
SearchScope(62-62)packages/web/src/features/chat/utils.ts (3)
slateContentToString(122-145)getAllMentionElements(147-159)createUIMessage(176-212)
packages/web/src/app/[domain]/chat/components/newChatPanel.tsx (2)
packages/web/src/features/chat/types.ts (1)
SearchScope(62-62)packages/web/src/features/chat/useCreateNewChatThread.ts (1)
useCreateNewChatThread(15-52)
packages/web/src/features/chat/components/searchScopeIcon.tsx (2)
packages/web/src/features/chat/types.ts (1)
SearchScope(62-62)packages/web/src/lib/utils.ts (2)
cn(20-22)getCodeHostIcon(272-303)
packages/web/src/features/chat/components/chatBox/searchScopeSelector.tsx (4)
packages/web/src/lib/types.ts (2)
RepositoryQuery(28-28)SearchContextQuery(29-29)packages/web/src/features/chat/types.ts (3)
SearchScope(62-62)RepoSetSearchScope(56-56)RepoSearchScope(48-48)packages/web/src/lib/utils.ts (1)
cn(20-22)packages/web/src/features/chat/components/searchScopeIcon.tsx (1)
SearchScopeIcon(11-32)
packages/web/src/app/[domain]/components/homepage/askSourcebotDemoCards.tsx (4)
packages/web/src/types.ts (2)
DemoExamples(28-28)DemoSearchScope(29-29)packages/web/src/lib/utils.ts (2)
cn(20-22)getCodeHostIcon(272-303)packages/web/src/components/searchScopeInfoCard.tsx (1)
SearchScopeInfoCard(5-41)packages/web/src/components/ui/card.tsx (2)
Card(79-79)CardContent(79-79)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (68)
packages/web/src/components/atMentionInfoCard.tsx (1)
1-15: LGTM! Well-structured info card component.The component follows React best practices with:
- Clean functional component structure
- Proper semantic HTML structure with headings and descriptions
- Consistent styling using Tailwind CSS utility classes
- Responsive design with
max-w-[90vw]for mobile compatibility- Proper accessibility with semantic heading structure
packages/web/src/app/[domain]/chat/components/newChatPanel.tsx (4)
8-8: Import updated correctly for the search scope refactor.The import change from
ContextItemtoSearchScopealigns with the broader refactor to unify repository and context selection.
27-27: State management correctly updated to use SearchScope[].The local storage key and type are appropriately updated from
selectedItemstoselectedSearchScopeswith the correctSearchScope[]type.
32-33: Function call correctly updated with new parameter.The
createNewChatThreadfunction call properly uses the newselectedSearchScopesparameter, consistent with the updated hook signature shown in the relevant code snippets.
52-52: Props correctly updated for child components.Both
ChatBoxandChatBoxToolbarcomponents receive the updatedselectedSearchScopesprop and setter function, maintaining consistency with the refactored component interfaces.Also applies to: 61-62
packages/web/src/components/searchScopeInfoCard.tsx (1)
1-41: LGTM! Comprehensive and user-friendly info card.The component provides clear explanations of the two search scope types with appropriate visual indicators. The fallback logic for the GitHub icon ensures robustness across different environments.
packages/web/src/features/chat/utils.ts (3)
15-15: Import correctly added for SearchScope type.The import addition aligns with the function signature changes and broader refactor.
176-176: Function signature correctly simplified.The change from separate
selectedReposandselectedContextsparameters to a singleselectedSearchScopes: SearchScope[]parameter simplifies the API and aligns with the unified search scope model.
209-209: Metadata structure correctly updated.The metadata object now includes
selectedSearchScopesinstead of separate arrays, maintaining consistency with the new data model.packages/web/src/features/chat/components/chatThread/detailsCard.tsx (2)
7-7: Imports correctly added for new UI functionality.The new imports for
Tooltip,ScanSearchIcon, andSearchScopeIconare appropriate for the added search scope display functionality.Also applies to: 9-9, 16-16
66-87: Well-implemented search scope display with tooltip.The implementation follows good practices:
- Properly conditional rendering based on
metadata?.selectedSearchScopes- Consistent with other metadata displays (only shown when not streaming)
- Uses appropriate accessibility with
cursor-helpclass- Tooltip content clearly shows each search scope with icon and name
- Proper pluralization handling for "scope" vs "scopes"
- Uses the
SearchScopeIconcomponent for consistent iconographypackages/web/src/features/chat/agent.ts (6)
19-19: LGTM: Clear parameter rename for better semantic clarity.The rename from
selectedRepostosearchScopeRepoNamesbetter reflects that these are repository names derived from search scopes rather than directly selected repositories.
38-38: LGTM: Parameter rename consistent with interface.The parameter rename aligns with the
AgentOptionsinterface update and maintains consistency throughout the function.
43-43: LGTM: Function call updated with renamed parameter.The function call correctly uses the renamed
searchScopeRepoNamesparameter.
153-157: LGTM: Interface and function signature consistently updated.The
BaseSystemPromptOptionsinterface andcreateBaseSystemPromptfunction signature are properly updated to use the newsearchScopeRepoNamesparameter name.
179-179: LGTM: Template literal correctly uses renamed variable.The template literal properly uses the renamed
searchScopeRepoNamesvariable to generate the repository list.
53-53: Parameter name mismatch is cosmetic, not a runtime issue
ThecreateCodeSearchToolfunction signature correctly accepts a singlestring[]argument (selectedRepos), and calling it withsearchScopeRepoNames(anotherstring[]) works as intended. There’s no runtime error risk—parameter names are local to the function and don’t affect invocation. Feel free to keep the current names or rename for readability, but no change is required for correctness.Likely an incorrect or invalid review comment.
packages/web/src/features/chat/useCreateNewChatThread.ts (4)
13-13: LGTM: Import updated to reflect new type system.The import correctly replaces
ContextItemwithSearchScopeto align with the unified search scope model.
21-21: LGTM: Function parameter updated to use unified search scope model.The parameter change from
selectedItems: ContextItem[]toselectedSearchScopes: SearchScope[]simplifies the API and aligns with the broader refactor.
25-25: LGTM: Simplified function call with unified search scopes.The direct pass of
selectedSearchScopestocreateUIMessagesimplifies the logic by eliminating the need to separate repos and contexts.
40-40: LGTM: URL state simplified with unified search scopes.The payload now uses a single
selectedSearchScopesproperty instead of separate repo and context arrays, consistent with theSetChatStatePayloadtype.packages/web/src/app/[domain]/chat/[id]/components/chatThreadPanel.tsx (7)
5-5: LGTM: Import added for new SearchScope type.The
SearchScopeimport is correctly added to support the updated state management.
38-38: LGTM: Simplified default value derivation.The direct use of
lastUserMessage?.metadata?.selectedSearchScopeseliminates complex logic for reconstructing selected items from separate repo and context arrays.
39-39: LGTM: State variable updated to use unified search scope model.The state variable correctly uses
SearchScope[]type and the simplified default value.
48-48: LGTM: URL parameter parsing simplified.The direct destructuring of
selectedSearchScopesfrom the payload eliminates complex reconstruction logic.
50-50: LGTM: State setter consistent with updated state variable.The
setSelectedSearchScopescall properly uses the parsed value from the URL parameter.
59-59: LGTM: Effect dependencies correctly simplified.Removing
reposandsearchContextsfrom the dependency array is appropriate since the effect no longer reconstructs selected items from these arrays.
75-76: LGTM: Props updated to use new search scope model.The
selectedSearchScopesandonSelectedSearchScopesChangeprops correctly reflect the updated component API.packages/web/src/features/chat/components/chatBox/chatBox.tsx (9)
6-6: LGTM: Import updated for new type system.The import correctly includes
SearchScopeto support the updated prop types.
31-31: LGTM: Prop type updated to unified search scope model.The prop change from
selectedItems: ContextItem[]toselectedSearchScopes: SearchScope[]aligns with the refactor.
44-44: LGTM: Prop destructuring updated consistently.The destructuring correctly uses the renamed
selectedSearchScopesprop.
55-68: LGTM: Repository extraction logic correctly updated.The logic properly handles both 'repo' and 'reposet' types from the search scopes. The flattening approach ensures all repository names are collected into a single array.
Note: The type check uses
'reposet'instead of the previous'context'- ensure this aligns with theSearchScopetype definition.
132-132: LGTM: Validation logic updated with new variable name.The validation correctly checks
selectedSearchScopes.lengthto ensure at least one search scope is selected.
156-156: LGTM: Memoization dependency updated correctly.The dependency array correctly uses
selectedSearchScopes.lengthto maintain proper memoization.
164-164: LGTM: Toast message updated with clearer terminology.The message now uses "search scope" terminology, which is more consistent and user-friendly than the previous "repository or context" phrasing.
286-286: LGTM: Placeholder text updated for consistency.The placeholder correctly references "selected search scopes" providing clear guidance to users about the new terminology.
341-341: LGTM: Tooltip text consistently updated.The tooltip message correctly uses "search scope" terminology, maintaining consistency with other user-facing messages.
packages/web/src/app/[domain]/components/homepage/agenticSearch.tsx (3)
6-6: LGTM! Clean import update.The import correctly replaces
ContextItemwithSearchScopeto align with the new unified model.
36-36: LGTM! Consistent state management refactor.The state variable and local storage key are properly updated to use the new
SearchScope[]type, maintaining backwards compatibility by changing the storage key.
44-44: LGTM! Proper prop propagation.The component correctly passes
selectedSearchScopesto child components (createNewChatThread,ChatBox, andChatBoxToolbar), maintaining consistency with the new unified model.Also applies to: 49-49, 60-61
packages/web/src/features/chat/components/chatBox/chatBoxToolbar.tsx (3)
6-6: LGTM! Clean import updates.The imports are correctly updated to use
SearchScopeinstead ofContextItemand include the new info card components that provide better user experience.Also applies to: 13-15
21-22: LGTM! Proper interface refactor.The props interface and parameters are correctly updated to use
selectedSearchScopes: SearchScope[]instead of the previous context item model, maintaining type safety.Also applies to: 31-32
67-78: LGTM! Enhanced UI with better user experience.The replacement of
ContextSelectorwithSearchScopeSelectorand the newSearchScopeInfoCardtooltip provides a more informative and consistent user experience. The tooltip styling with transparent background and no border creates a clean presentation.packages/web/src/features/chat/components/chatThread/chatThread.tsx (4)
8-8: LGTM! Import properly updated.The import correctly includes
SearchScopeto support the new unified selection model.
38-39: LGTM! Simplified and consistent props interface.The props interface is correctly updated to use
selectedSearchScopes: SearchScope[], eliminating the complexity of managing separate repository and context selections.Also applies to: 50-51
118-118: LGTM! Consistent usage throughout the component.All references to the selected items are properly updated to use
selectedSearchScopes, maintaining consistency in the sendMessage callback, createUIMessage call, and dependency arrays.Also applies to: 122-122, 238-238, 244-244
322-322: LGTM! Proper prop propagation to child components.The component correctly passes
selectedSearchScopesand the change handler to bothChatBoxandChatBoxToolbar, ensuring the unified model flows through the component hierarchy.Also applies to: 331-332
packages/web/src/types.ts (3)
7-7: LGTM! Improved schema naming and clarity.The schema rename from
demoSearchContextSchematodemoSearchScopeSchemaand the enum value change from"set"to"reposet"provides better clarity and consistency with the unified search scope model.Also applies to: 11-11
19-19: LGTM! Consistent field naming updates.The schema updates correctly rename
searchContextstosearchScopesin both the example and root schemas, maintaining consistency throughout the type system.Also applies to: 23-23
29-30: LGTM! Type exports properly updated.The exported types are correctly updated to reflect the schema changes, replacing
DemoSearchContextwithDemoSearchScopeand updatingDemoSearchExampleaccordingly.packages/web/src/app/api/(server)/chat/route.ts (3)
5-5: LGTM! Consistent API interface updates.The import, request parsing, and parameter passing are all correctly updated to use the new
selectedSearchScopes: SearchScope[]model, maintaining type safety throughout the API handler.Also applies to: 67-67, 71-71, 95-95
189-212: LGTM! Well-structured scope expansion logic.The expansion logic correctly handles both
repoandreposettypes, with proper async handling and database queries. The flattening approach consolidates all repository names into a single array.
220-220: LGTM! Clean parameter naming and metadata inclusion.The parameter rename to
searchScopeRepoNamesbetter reflects its purpose, and includingselectedSearchScopesin the message metadata provides valuable context for debugging and analytics.Also applies to: 246-246
packages/web/src/app/[domain]/components/homepage/askSourcebotDemoCards.tsx (5)
3-3: LGTM on import additions!The new imports align perfectly with the refactored functionality -
useStatefor filter state, new Lucide icons for the UI,DemoSearchScopetype for filtering logic, andSearchScopeInfoCardfor the tooltip component.Also applies to: 5-5, 9-9, 12-12
22-22: Good state management simplification!The single filter state is cleaner than the previous multi-selection approach and the typing (
number | null) clearly indicates that null means "show all".
85-131: Excellent UI structure implementation!The search scope filter section is well-designed with:
- Clear info tooltip using the
SearchScopeInfoCardcomponent- Consistent badge styling for selected/unselected states
- Proper event handling for filter state updates
- Nice tooltip positioning with CSS arrow
134-139: Clean and correct filtering logic!The filter implementation properly handles both the "show all" case (null filter) and specific scope filtering using array inclusion check.
140-169: Well-implemented card rendering!The example cards properly display search scope badges with icons, maintain consistent styling, and handle user interactions correctly. The logic to filter and display relevant search scopes for each example is sound.
packages/web/src/features/chat/components/chatBox/searchScopeSelector.tsx (7)
7-7: Import updates look correct!The new imports properly support the refactored functionality -
ScanSearchIconfor the UI,cnfor class utilities, the new search scope types, and the unifiedSearchScopeIconcomponent.Also applies to: 10-10, 28-29
31-43: Interface refactoring is well-executed!The rename to
SearchScopeSelectorand the prop changes to useselectedSearchScopeswith unifiedSearchScope[]type make the component more focused and easier to understand.
61-94: State handling logic is correctly updated!The toggle and keyboard handling logic properly works with the unified
SearchScopetype, maintaining the same UX behavior while using the new data structure. The scroll position preservation is a nice touch.
100-116: Item mapping logic is solid!The transformation from separate contexts and repos into unified
SearchScopeitems is well-implemented with proper type discriminators and field mappings.
118-142: Excellent sorting and scroll restoration logic!The multi-level sorting (selected first, then reposets before repos) provides intuitive UX, and the scroll position restoration maintains smooth interactions during state updates.
160-225: UI updates are consistent and well-implemented!The terminology updates, unified icon usage via
SearchScopeIcon, and proper type checking for badges all align with the search scope refactoring. The UI maintains the same functionality while using the new data model.
245-245: Display name properly updated!The component display name correctly reflects the refactored component name.
packages/web/src/features/chat/types.ts (3)
42-62: Well-designed search scope type system!The discriminated union approach with proper type literals ('repo' vs 'reposet') provides excellent type safety. The schema fields are appropriately typed and the structure supports the unified search scope model effectively.
75-75: Metadata schema properly updated!The
selectedSearchScopesfield correctly uses the new search scope schema as an optional array, maintaining backward compatibility while supporting the unified model.
163-163: Payload and request params schemas correctly updated!Both
SetChatStatePayloadandadditionalChatRequestParamsSchemaproperly use the new search scope types, with appropriate optionality for their respective contexts.Also applies to: 180-180
Summary by CodeRabbit
New Features
Refactor
Style
Documentation