Add methods for new index settings: facetSearch and prefixSearch

[thicolares]

Pull Request

Related issue

Fixes #1048

What does this PR do?

• Add methods for Facet and Prefix Search settings
• Add respective code samples
• Handle boolean body for POST requests -- for now, used by Facet Search settings

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 managing facet search settings on indexes, including retrieving, updating, and resetting these settings.
  • Added support for managing prefix search settings on indexes, including retrieving, updating, and resetting these settings.

• Documentation

  • Expanded code samples to demonstrate usage of new facet search and prefix search settings operations.

• Tests

  • Introduced tests to verify correct behavior of facet search and prefix search settings management.

[thicolares]

I believe these nested ifs are bit convoluted. But I decided not revamping them now :) Previous PRs suggest it might be for backward compatibility

[thicolares]

Note inconsistency: get_facet_search_settings (note the _settings suffix) x get_prefix_search. Is there a reason for that? I left as is for consistency with existing implementations.

[brunoocasali]

Indeed, there is a lack of standards in those method definitions... But it is good enough for now :)

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This change adds support for the new facetSearch and prefixSearch index settings in the Meilisearch Python client. It introduces corresponding methods to the Index class, updates request handling, adds a PrefixSearch enum, extends configuration paths, provides code samples, and implements comprehensive tests for both features.

Changes

File(s)	Change Summary
.code-samples.meilisearch.yaml	Added code samples for getting, updating, and resetting facet search and prefix search settings.
meilisearch/_httprequests.py	Updated request body type annotations and logic to support boolean and PrefixSearch for settings.
meilisearch/config.py	Added prefix_search path constant to configuration.
meilisearch/index.py	Added methods to get, update, and reset facet search and prefix search settings in the Index class.
meilisearch/models/index.py	Introduced PrefixSearch enum with INDEXING_TIME and DISABLED values.
tests/settings/test_settings_facet_search.py	Added tests for getting, updating, and resetting facet search settings.
tests/settings/test_settings_prefix_search.py	Added tests for getting, updating, and resetting prefix search settings.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Index
    participant HttpRequests
    participant MeilisearchServer

    User->>Index: get_facet_search_settings()
    Index->>HttpRequests: GET /settings/facet-search
    HttpRequests->>MeilisearchServer: HTTP GET
    MeilisearchServer-->>HttpRequests: Boolean response
    HttpRequests-->>Index: Boolean value
    Index-->>User: Boolean value

    User->>Index: update_prefix_search(PrefixSearch.DISABLED)
    Index->>HttpRequests: PUT /settings/prefix-search (body: "disabled")
    HttpRequests->>MeilisearchServer: HTTP PUT
    MeilisearchServer-->>HttpRequests: TaskInfo
    HttpRequests-->>Index: TaskInfo
    Index-->>User: TaskInfo

    User->>Index: reset_facet_search_settings()
    Index->>HttpRequests: DELETE /settings/facet-search
    HttpRequests->>MeilisearchServer: HTTP DELETE
    MeilisearchServer-->>HttpRequests: TaskInfo
    HttpRequests-->>Index: TaskInfo
    Index-->>User: TaskInfo

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add methods to configure facetSearch and prefixSearch index settings (#1048)	✅
Add integration tests for facetSearch and prefixSearch settings (#1048)	✅
Update code samples for get/update/reset_facet_search_settings_1 and get/update/reset_prefix_search_settings_1 (#1048)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related issues

• [v1.12.0] New index settings: facetSearch and prefixSearch meilisearch-java#797: Implements the same feature for managing facetSearch and prefixSearch settings in the Java client.
• [v1.12.0] New index settings: facetSearch and prefixSearch meilisearch-rust#626: Addresses similar API and settings management for Rust client.
• [v1.12.0] New index settings: facetSearch and prefixSearch meilisearch-dotnet#596: Adds these settings and related API methods in the .NET client.
• [v1.12.0] New index settings: facetSearch and prefixSearch meilisearch-swift#456: Implements these settings and methods in the Swift client.

Poem

The rabbit hopped with settings new,
For facets and prefixes, it knew just what to do.
With toggles and resets, the code did shine,
Tests ensure it all works fine.
Now search is swift, with options galore—
Hooray for features, and here’s to more!
((\
( -.-)
o_(")(")

---

📜 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 a43baec and de723fa.

📒 Files selected for processing (7)

• .code-samples.meilisearch.yaml (2 hunks)
• meilisearch/_httprequests.py (4 hunks)
• meilisearch/config.py (1 hunks)
• meilisearch/index.py (3 hunks)
• meilisearch/models/index.py (1 hunks)
• tests/settings/test_settings_facet_search.py (1 hunks)
• tests/settings/test_settings_prefix_search.py (1 hunks)

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

[brunoocasali]

LGTM!