feat: Work Items state in the search result
Description
Implemented work item status to display in the search result
Fixes #7722 Fixes #8144
Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x ] Feature (non-breaking change which adds functionality)
- [ ] Improvement (change that would cause existing functionality to not work as expected)
- [ ] Code refactoring
- [ ] Performance improvements
- [ ] Documentation update
Screenshots and Media (if applicable)
Workspace search
Command+k
Test Scenarios
References
[!NOTE] Adds issue state to search results and surfaces it in the Power-K UI.
- API:
GlobalSearchEndpoint.filter_issuesnow returnsstatein issue search payloads- UI: Power-K search results for
issuerender a read-onlyStateDropdownnext toIssueIdentifierWritten by Cursor Bugbot for commit 4cfbb1f89af0b46dd1c10a45b3148c064e550402. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
- New Features
- Search results now display the state/status of each issue, allowing users to quickly view the current status of work items directly within search results. The state is shown in a read-only format alongside issue information for improved visibility.
✏️ Tip: You can customize this high-level summary in your review settings.
📝 Walkthrough
Walkthrough
This change adds work item state information to global search results. The backend now includes the "state" field in the API response for searched issues, and the frontend displays this state using a read-only StateDropdown component in the search results modal.
Changes
| Cohort / File(s) | Summary |
|---|---|
Backend API Enhancement apps/api/plane/app/views/search/base.py |
Added "state" field to the values dictionary returned by filter_issues() method, expanding the issue payload to include state data in search results. |
Frontend UI Display apps/web/core/components/power-k/ui/modal/search-results-map.tsx |
Imported StateDropdown component and integrated it into the issue group item rendering to display work item state as a read-only, background-styled badge in search results. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
🐰 A search through the warren, revealing the way, Now showing what state each work item's in—at play! No more guessing open from done with a glance, The status shines bright, giving work items their chance. ✨
Pre-merge checks and finishing touches
❌ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage | ⚠️ Warning | Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. | You can run @coderabbitai generate docstrings to improve docstring coverage. |
✅ Passed checks (4 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title 'feat: Work Items state in the search result' clearly and concisely describes the main change—adding work item status display to search results. |
| Description check | ✅ Passed | The description covers the main change, includes references to linked issues (#7722, #8144), specifies the type of change (feature), and provides screenshots demonstrating the implementation. |
| Linked Issues check | ✅ Passed | The PR successfully implements the primary requirement from both linked issues: displaying work item status in search results alongside each item in both workspace search and Command+K UI. |
| Out of Scope Changes check | ✅ Passed | All changes focus narrowly on adding state display to search results; no unrelated modifications or scope creep detected in the API and UI layer updates. |
✨ Finishing touches
- [ ] 📝 Generate docstrings
🧪 Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
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.
Comment @coderabbitai help to get the list of available commands and usage tips.