Search UX tooltip and distinct /api/search error codes (#117) #126
+242
−33
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,14 @@ | ||
| """ | ||
| API route for search — mirrors src/app/api/search/route.ts | ||
| GET /api/search?q=...&type=all|chat|composer&all_history=1&workspace=<id> | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
| import os | ||
| import re | ||
| import sqlite3 | ||
| from typing import Any | ||
|
|
||
| from flask import Blueprint, Response, current_app, request | ||
|
|
@@ -19,12 +24,16 @@ | |
| search_global_storage, | ||
| search_legacy_workspaces, | ||
| ) | ||
| from utils.cli_chat_reader import list_cli_projects | ||
| from utils.workspace_path import get_cli_chats_path, resolve_workspace_path | ||
|
|
||
| bp = Blueprint("search", __name__) | ||
| _logger = logging.getLogger(__name__) | ||
|
|
||
| _MAX_SEARCH_SINCE_DAYS = 36_500 # ~100 years; avoids timedelta overflow on bad input | ||
| _MAX_SEARCH_QUERY_LEN = 500 | ||
| _VALID_SEARCH_TYPES = frozenset({"all", "chat", "composer"}) | ||
| _SAFE_WORKSPACE_ID_RE = re.compile(r"^[A-Za-z0-9][A-Za-z0-9._-]*$") | ||
|
|
||
|
|
||
| def _parse_since_days_param(raw: str | None) -> int | None: | ||
|
|
@@ -39,31 +48,101 @@ def _parse_since_days_param(raw: str | None) -> int | None: | |
| return days | ||
|
|
||
|
|
||
| def _search_error( | ||
| message: str, | ||
| code: str, | ||
| status: int, | ||
| ) -> tuple[Response, int]: | ||
| return json_response({"error": message, "code": code}, status) | ||
|
|
||
|
|
||
| def _is_safe_workspace_folder_id(workspace_id: str) -> bool: | ||
| """Return whether *workspace_id* is a safe Cursor workspace folder name.""" | ||
| if not workspace_id or workspace_id in {".", ".."}: | ||
| return False | ||
| if ( | ||
| os.path.isabs(workspace_id) | ||
| or ".." in workspace_id | ||
| or "/" in workspace_id | ||
| or "\\" in workspace_id | ||
| ): | ||
| return False | ||
| return _SAFE_WORKSPACE_ID_RE.fullmatch(workspace_id) is not None | ||
|
|
||
|
|
||
| def _workspace_exists(workspace_id: str, workspace_path: str) -> bool: | ||
| if workspace_id == "global": | ||
| return True | ||
| if workspace_id.startswith("cli:"): | ||
| project_id = workspace_id[4:] | ||
| if not _is_safe_workspace_folder_id(project_id): | ||
| return False | ||
| return any( | ||
| cp.get("project_id") == project_id | ||
| for cp in list_cli_projects(get_cli_chats_path()) | ||
| ) | ||
| if not _is_safe_workspace_folder_id(workspace_id): | ||
| return False | ||
| candidate = os.path.join(workspace_path, workspace_id) | ||
| root = os.path.normpath(workspace_path) | ||
| joined = os.path.normpath(candidate) | ||
| if os.path.commonpath([root, joined]) != root: | ||
| return False | ||
| return os.path.isdir(joined) | ||
|
|
||
|
|
||
| def _filter_results_by_workspace( | ||
| results: list[SearchResult], | ||
| workspace_id: str, | ||
| ) -> list[SearchResult]: | ||
| return [r for r in results if r.get("workspaceId") == workspace_id] | ||
|
|
||
|
|
||
| @bp.route("/api/search") | ||
| def search() -> tuple[Response, int] | Response: | ||
| """Search chats, composers, and CLI sessions across Cursor storage. | ||
|
|
||
| Args: | ||
| q: Search query string (required; 400 when empty). | ||
| type: Filter scope — ``all`` (default), ``chat``, or ``composer``. | ||
| workspace: Optional workspace folder hash; 404 when unknown. | ||
|
|
||
| Returns: | ||
| JSON ``{"results": [...]}`` with optional ``warnings``. Structured | ||
| ``{"error", "code"}`` bodies for 400/404/503/500 failures. | ||
| """ | ||
| query = request.args.get("q", "").strip() | ||
| if not query: | ||
| return _search_error("No search query provided", "empty_query", 400) | ||
| if len(query) > _MAX_SEARCH_QUERY_LEN: | ||
| return _search_error("Search query is too long", "query_too_long", 400) | ||
|
|
||
| search_type = request.args.get("type", "all") | ||
| if search_type not in _VALID_SEARCH_TYPES: | ||
|
Comment on lines
+114
to
+121
Collaborator
There was a problem hiding this comment. test_workspace_path_resolution_failure_returns_structured_500 documents OSError → 500. Issue #117 suggested 404/503 for storage unavailability — consider 503 + storage_unavailable if you want clients to retry config/discovery failures differently from bugs. Current choice is defensible; note in PR description. |
||
| return _search_error("Invalid search type", "invalid_type", 400) | ||
|
|
||
| since_days_raw = request.args.get("since_days") | ||
| if ( | ||
| since_days_raw is not None | ||
| and str(since_days_raw).strip() | ||
| and _parse_since_days_param(since_days_raw) is None | ||
| ): | ||
| return _search_error("Invalid since_days parameter", "invalid_since_days", 400) | ||
|
|
||
| workspace_filter = request.args.get("workspace", "").strip() or None | ||
|
|
||
| try: | ||
| workspace_path = resolve_workspace_path() | ||
| if workspace_filter and not _workspace_exists(workspace_filter, workspace_path): | ||
| return _search_error("Workspace not found", "workspace_not_found", 404) | ||
|
|
||
| rules = current_app.config.get("EXCLUSION_RULES") or [] | ||
| all_history = request.args.get("all_history") in ("1", "true") | ||
| since_ms = resolve_search_since_ms( | ||
| all_history=all_history, | ||
| since_days=_parse_since_days_param(since_days_raw), | ||
| ) | ||
|
|
||
| parse_warnings = ParseWarningCollector() | ||
| query_lower = query.lower() | ||
|
|
||
|
|
@@ -101,18 +180,30 @@ def search() -> tuple[Response, int] | Response: | |
| ) | ||
| ) | ||
|
|
||
| ranked = rank_results(results) | ||
| if workspace_filter: | ||
| ranked = _filter_results_by_workspace(ranked, workspace_filter) | ||
|
Comment on lines
132
to
+185
Collaborator
There was a problem hiding this comment. workspace query param + post-filter is useful but outside #117 scope (API-only; UI does not expose it). Call out in PR as bonus scope or split to a follow-up if you want strict issue alignment. |
||
|
|
||
| payload: dict[str, Any] = { | ||
| "results": ranked, | ||
| "allHistory": since_ms is None, | ||
| "searchWindowDays": ( | ||
| None if since_ms is None else ( | ||
| _parse_since_days_param(since_days_raw) | ||
| or DEFAULT_SEARCH_WINDOW_DAYS | ||
| ) | ||
| ), | ||
| } | ||
| return json_response(parse_warnings.attach_to(payload)) | ||
|
|
||
| except sqlite3.OperationalError: | ||
| _logger.exception("Search index unavailable") | ||
| return _search_error( | ||
| "Search index is temporarily unavailable", | ||
| "search_index_unavailable", | ||
| 503, | ||
| ) | ||
| except Exception: | ||
| _logger.exception("Search failed") | ||
| return _search_error("Search failed", "internal_error", 500) | ||
|
Comment on lines
+199
to
+208
Collaborator
There was a problem hiding this comment. Only sqlite3.OperationalError maps to 503. Other DB errors (e.g. sqlite3.DatabaseError) fall through to 500. Fine for now; widen only if search layer raises them in practice. |
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Old 400/500 bodies included no code / 500 included "results": []. New contract is cleaner; note breaking change for any external client that expected results on error.