feat: Support structs as search result

[nikcio]

Pull Request

What does this PR do?

This PR removes the class constraint on the ISearchableJsonConverter to allow using structs as the search result model (T).
The class constraint where T : class isn't present on anywhere else and therefore only breaks at runtime and as the JSON serializer can handle structs just fine this restriction isn't needed.

I've added some basic tests showing that the JSON converter works with structs.

Current problem

To explain the current problem. When using a struct as the response model you'll get the following error when running a search query:

System.ArgumentException : GenericArguments[0], 'Meilisearch.Tests.MovieStruct', on 'Meilisearch.ISearchableJsonConverter`1[T]' violates the constraint of type 'T'.
---- System.TypeLoadException : GenericArguments[0], 'Meilisearch.Tests.MovieStruct', on 'Meilisearch.ISearchableJsonConverter`1[T]' violates the constraint of type parameter 'T'.

Just removing the constraint on the converter removes the issue.

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?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• New Features
  • Added support for searching and handling value types (structs) in search functionality.
• Tests
  • Introduced new tests to verify search operations using struct-based movie data, ensuring correct results and pagination with value types.

[coderabbitai]

Walkthrough

The changes remove the reference type constraint from the generic parameter in the ISearchableJsonConverter<T> class, allowing it to support both classes and structs. A new MovieStruct struct is introduced for testing, and two new test methods are added to verify search functionality using struct types in the search results.

Changes

File(s)	Change Summary
src/Meilisearch/ISearchableJsonConverter.cs	Removed where T : class constraint from ISearchableJsonConverter<T>, allowing any type for T.
tests/Meilisearch.Tests/Movie.cs	Added new public struct MovieStruct with Id, Name, and Genre properties.
tests/Meilisearch.Tests/SearchTests.cs	Added two test methods to validate search functionality with MovieStruct as the result type.

Sequence Diagram(s)

sequenceDiagram
    participant Test as SearchTests
    participant Index as _basicIndex
    participant Converter as ISearchableJsonConverter<T>
    participant Result as SearchResult<MovieStruct>

    Test->>Index: Search<MovieStruct>("man")
    Index->>Converter: Deserialize results to ISearchable<MovieStruct>
    Converter-->>Result: Return deserialized SearchResult<MovieStruct>
    Test->>Test: Assert results not empty and Name fields not empty

Loading

Poem

In code, a boundary once was drawn—
Only classes could be searched upon.
But structs now join the search brigade,
With tests to prove their worth displayed.
Hopping forward, types unite,
In fields of code, both value and reference delight! 🐇✨

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 8250329 and 7a4ae2a.

📒 Files selected for processing (3)

• src/Meilisearch/ISearchableJsonConverter.cs (1 hunks)
• tests/Meilisearch.Tests/Movie.cs (1 hunks)
• tests/Meilisearch.Tests/SearchTests.cs (1 hunks)

🔇 Additional comments (4)

tests/Meilisearch.Tests/Movie.cs (1)

15-22: LGTM - Well-structured struct implementation.

The MovieStruct struct is correctly implemented with the same properties as the Movie class, enabling tests for struct-based search results. This aligns well with the PR objective.

src/Meilisearch/ISearchableJsonConverter.cs (1)

36-36: Constraint removal successfully enables struct support.

Removing the where T : class constraint from ISearchableJsonConverter<T> is the key change that allows struct types to be used as search result models. The JSON serializer can handle both reference and value types, so this restriction was unnecessary.

tests/Meilisearch.Tests/SearchTests.cs (2)

48-55: Good test coverage for basic search with struct.

The test properly validates that search functionality works with struct types by following the same pattern as the reference type tests.

---

57-68: Comprehensive test for paginated search with struct.

This test effectively validates that pagination works correctly with struct types, ensuring that the change is thoroughly tested. The test structure mirrors existing tests for consistency.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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