Added show_performance_details option to search, multi-search, federated multi-search and similar

[aznszn]

Pull Request

Related issue

Closes #764

What does this PR do?

• Added show_performance_details: Option<bool> field to SearchQuery, SimilarQuery, FederationOptions
• Added performance_details: Option<Value> field to SearchResults, SimilarResults, FederatedMultiSearchResponse to represent raw performance details in responses
• Added with_show_performance_details method to SearchQuery and SimilarQuery

PR checklist

Please check if your PR fulfills the following requirements:

• Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.
  Did not use AI
• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Summary by CodeRabbit

• New Features
  • Added performance tracing support to search queries—users can now request and receive detailed performance metrics in responses.
  • Performance details now available for similar item queries.
  • Performance traces included in federated search responses for better monitoring.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes add performance tracing support to search and similar document query operations by introducing show_performance_details flags to query structs and performance_details fields to response structs across search, federated multi-search, and similar document endpoints, along with corresponding builder methods and tests.

Changes

Cohort / File(s)	Summary
Search Performance Tracing src/search.rs	Added show_performance_details: Option<bool> field and with_show_performance_details() builder method to SearchQuery; added performance_details: Option<Value> field to SearchResults; added show_performance_details: Option<bool> to FederationOptions and performance_details: Option<Value> to FederatedMultiSearchResponse; includes tests for single, multi, and federated search scenarios.
Similar Documents Performance Tracing src/similar.rs	Added show_performance_details: Option<bool> field and with_show_performance_details() builder method to SimilarQuery; added performance_details: Option<Value> field to SimilarResults; includes test verifying performance details are returned when requested.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Implement federated multi search #681: Extends federated search types by adding show_performance_details and performance_details fields to SearchQuery, FederationOptions, SearchResults, and FederatedMultiSearchResponse.
• Implement federated multi search #625: Modified federated multi-search structures in src/search.rs that are now extended with performance tracing support.
• Add support for similar docs query #674: Added SimilarQuery and SimilarResults types that are now extended with show_performance_details and performance_details fields.

Suggested labels

enhancement

Poem

🐰 ✨ Performance traces now revealed,
With showPerformanceDetails sealed,
Search and similar shine bright,
Exposing timing's precious light,
Raw data flows, no types constrained! 🎯

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and concisely describes the main change: adding show_performance_details option to multiple search-related features.
Linked Issues check	✅ Passed	The PR implements all coding requirements from issue #764: added show_performance_details to search, multi-search, federated multi-search, and similar; added performance_details to responses; included builder methods and test cases.
Out of Scope Changes check	✅ Passed	All changes are directly aligned with the linked issue #764 requirements; no out-of-scope modifications detected.
Docstring Coverage	✅ Passed	Docstring coverage is 86.67% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Failure to add the new IP will result in interrupted reviews.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[aznszn]

@Strift this is ready for review

[Strift]

Thanks @aznszn 🙌 LGTM