Skip to content

Serialize for MultiSearchResponse #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

milesgranger
Copy link

@milesgranger milesgranger commented May 19, 2025

What does this PR do?

This adds serde::Serialize to MultiSearchResponse.

I'm in a situation where I proxy requests between client and Meilisearch. During which I have authentication via OAuth and although client has logic in place, I want to inspect responses from Meilisearch and ensure the authenticated user is only getting data they are authorized for given group associations, whether indices or specific records in other index hits.

The knee-jerk suggestion is to use different API keys. However, we have indices where for different users they have different permissions on what they can see and it's just not feasible/practical to duplicate indices/records into every combination of access rights.

PR checklist

Please check if your PR fulfills the following requirements:

  • 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
    • Improved support for exporting search results and related data in serialized formats.

Copy link

coderabbitai bot commented May 19, 2025

Walkthrough

The update adds the Serialize trait derivation to several structs in the src/search.rs file, which previously only derived Deserialize. No fields or logic within these structs are changed; only their ability to be serialized is added.

Changes

File(s) Change Summary
src/search.rs Added Serialize trait derivation to MatchRange, SearchResult<T>, FacetStats, SearchResults<T>, and MultiSearchResponse<T> structs. No other changes made.

Poem

In the warren where data flows free,
Now structs can serialize, as easy as can be!
From search results to facets, all ready to send,
A hop and a skip, their journeys won’t end.
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 90a153c and df984d9.

📒 Files selected for processing (1)
  • src/search.rs (4 hunks)
🔇 Additional comments (5)
src/search.rs (5)

9-9: Verify Derive of Serialize on MatchRange

Adding Serialize to the derive list for MatchRange is correct—its fields (usize and Option<Vec<usize>>) all implement Serialize, and the derive macro will generate the necessary impl Serialize.


53-53: Approve Serialize Derivation on SearchResult

Deriving Serialize alongside Deserialize for SearchResult<T> is safe: all annotated fields and the generic T (when bound by Serialize) support serialization.


71-71: Approve Serialize on FacetStats

The addition of Serialize to FacetStats is straightforward—its f64 fields are serializable.


78-78: Approve Serialize Derivation on SearchResults

Enabling Serialize for SearchResults<T> correctly covers all its fields (primitive types and Vec<SearchResult<T>>), and the derive macro will add the appropriate T: Serialize bound.


660-660: Approve Serialize on MultiSearchResponse

Deriving Serialize for MultiSearchResponse<T> ensures that users can round-trip or introspect multi-search results. The generic T: Serialize bound is automatically applied—this aligns with the PR goal to support proxy inspection.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant