Skip to content

Improve distinct attribute search tests #754

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

Strift
Copy link
Collaborator

@Strift Strift commented May 23, 2025

Pull Request

Improved tests for distinct attributes at search time while investigating #724

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

  • Tests
    • Updated search tests to verify that distinct search results include one entry per unique genre, including documents without a genre.

@Strift Strift added the maintenance Anything related to maintenance (CI, tests, refactoring...) label May 23, 2025
Copy link

coderabbitai bot commented May 23, 2025

Walkthrough

The test method testSearchWithDistinctAttribute in SearchTest.php was updated. The genre filter was removed, and the assertions were modified to check for four unique genre results, including documents without a genre. The test now ensures that each genre appears only once and verifies the expected set of genres.

Changes

File(s) Change Summary
tests/Endpoints/SearchTest.php Updated testSearchWithDistinctAttribute: removed genre filter, asserted four unique genres (including null), and verified uniqueness of each genre in the results.

Poem

A search for genres, wide and free,
Now finds four, not one or three.
Romance, adventure, fantasy too,
And even those with nothing new.
Each genre stands alone, distinct—
Our test now checks just what we think!
🐇✨

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.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 520036c and 830fe2b.

📒 Files selected for processing (1)
  • tests/Endpoints/SearchTest.php (1 hunks)
🔇 Additional comments (1)
tests/Endpoints/SearchTest.php (1)

893-909: Excellent improvement to the distinct attribute test!

This is a much more comprehensive test that properly validates the distinct attribute functionality. The improvements include:

  1. Complete coverage: Tests all unique genres instead of just filtered results
  2. Duplicate detection: Properly validates that each genre appears only once
  3. Null handling: Correctly handles documents without a genre using the ?? operator
  4. Clear assertions: Provides descriptive error messages for better debugging

The test logic is well-structured and thoroughly validates the distinct search behavior.

One minor suggestion for even better maintainability:

+        // Ensure we have the expected number of unique genres from test data
         $expectedGenres = ['romance', 'adventure', 'fantasy', null];
+        self::assertSame(count($expectedGenres), count($response['hits']), 
+            'Number of hits should match expected unique genres');

This would make the relationship between expected genres and hit count more explicit.

✨ 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
maintenance Anything related to maintenance (CI, tests, refactoring...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants