Skip to content

Add disableOnNumbers #636

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

Nymuxyzo
Copy link
Contributor

@Nymuxyzo Nymuxyzo commented Jun 17, 2025

Pull Request

Related issue

Fixes #635

What does this PR do?

Add disableOnNumbers to tests

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

    • Added a new code sample demonstrating how to enable typo tolerance settings that disable tolerance on numbers for the 'books' index.
  • Tests

    • Extended test coverage to include the new typo tolerance option for disabling on numbers and updated naming conventions for related settings.

Copy link

coderabbitai bot commented Jun 17, 2025

Walkthrough

A new code sample demonstrating the use of the disableOnNumbers option in typo tolerance settings was added. Additionally, the test suite for index settings was updated to include and verify the disableOnNumbers attribute, aligning key naming conventions to camelCase and expanding test coverage for typo tolerance configuration.

Changes

File(s) Change Summary
.code-samples.meilisearch.yaml Added typo_tolerance_guide_5 code sample showing usage of disable_on_numbers: true.
spec/meilisearch/index/settings_spec.rb Updated tests to include disableOnNumbers in typo tolerance settings; switched keys to camelCase.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CodeSample
    participant TestSuite

    User->>CodeSample: Add code sample with disableOnNumbers
    User->>TestSuite: Update test to include disableOnNumbers
    TestSuite->>TestSuite: Run typo tolerance tests with disableOnNumbers
Loading

Assessment against linked issues

Objective Addressed Explanation
Update settings API to handle disableOnNumbers for typo tolerance (#635)
Add a code sample under typo_tolerance_guide_5 in .code-samples.meilisearch.yaml (#635)
Add new test cases for disableOnNumbers in typo tolerance (#635)

Possibly related issues

Poem

A bunny hopped through fields of code,
Typo tolerance in its load.
With numbers now immune to slips,
The tests all pass—no sinking ships!
Code samples clear, the docs delight,
This rabbit’s work is out of sight!
🐇✨

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

@Nymuxyzo
Copy link
Contributor Author

I'm wondering why, after resetting the settings and waiting for it, the new value still applies and not the default one

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (1)
spec/meilisearch/index/settings_spec.rb (1)

617-623: Reset-assertion now mismatched – adjust to new default.

After applying the first fix, adapt the reset assertion to expect the updated default_typo_tolerance (with true).

-      expect(index.typo_tolerance).to include(default_typo_tolerance)
+      expect(index.typo_tolerance).to include(default_typo_tolerance)

(only value change earlier is required; the method call remains.)

🧹 Nitpick comments (1)
spec/meilisearch/index/settings_spec.rb (1)

599-603: Minor consistency nit – avoid redundant value flip.

Since the server’s default is already true, keeping new_typo_tolerance['disableOnNumbers'] at true doesn’t test anything.
Consider switching it to false so the update actually exercises a state change.

-        'disableOnNumbers' => true
+        'disableOnNumbers' => false
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1091577 and 4d0dd56.

📒 Files selected for processing (2)
  • .code-samples.meilisearch.yaml (1 hunks)
  • spec/meilisearch/index/settings_spec.rb (2 hunks)
🧰 Additional context used
🪛 GitHub Actions: Tests
spec/meilisearch/index/settings_spec.rb

[error] 622-622: RSpec test failure: Meilisearch::Index - Settings On typo tolerance #reset_typo_tolerance resets typo tolerance settings. Expected 'disableOnNumbers' to be false but got true.

🔇 Additional comments (1)
.code-samples.meilisearch.yaml (1)

597-599: Snippet aligns with client-side snake_case conventions – looks good.

The new example follows the existing pattern (disable_on_*) and demonstrates the feature concisely. No issues spotted.

Comment on lines +587 to 589
'disableOnAttributes' => [],
'disableOnNumbers' => false
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Default expectation is wrong – breaks the test suite.

disableOnNumbers is asserted to be false, but CI shows Meilisearch returns true by default after both creation and reset.
Update the spec to reflect the server’s actual default to unblock the pipeline.

-        'disableOnNumbers' => false
+        'disableOnNumbers' => true
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
'disableOnAttributes' => [],
'disableOnNumbers' => false
}
'disableOnAttributes' => [],
'disableOnNumbers' => true
}
🤖 Prompt for AI Agents
In spec/meilisearch/index/settings_spec.rb around lines 587 to 589, the test
expects 'disableOnNumbers' to be false by default, but the actual Meilisearch
server returns true after creation and reset. Update the spec to expect
'disableOnNumbers' to be true to match the server's actual default behavior and
fix the failing tests.

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.

[v1.15] Add disableOnNumbers to typo tolerance settings
1 participant