Skip to content

Update experimental features #1977

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

flevi29
Copy link
Collaborator

@flevi29 flevi29 commented Jul 1, 2025

Pull Request

What does this PR do?

  • updates experimental features with new chatCompletions property
  • makes docker compose use latest meilisearch (workflow tests already use latest version!!) (will have to implement something for keeping library versions in sync with their supported meilisearch versions in a future issue + PR)

Summary by CodeRabbit

  • New Features

    • Added a new experimental feature flag for "chat completions" that can be toggled at runtime.
  • Chores

    • Updated Docker Compose configuration to use the latest Meilisearch image by default.
  • Tests

    • Enhanced experimental feature tests to include the new "chat completions" flag.

@flevi29 flevi29 requested review from brunoocasali and Strift July 1, 2025 07:51
@flevi29 flevi29 added the enhancement New feature or request label Jul 1, 2025
Copy link

coderabbitai bot commented Jul 1, 2025

Walkthrough

The changes update the Docker Compose configuration to use the latest Meilisearch image by removing the fixed version tag. Additionally, a new optional chatCompletions property is added to the RuntimeTogglableFeatures type, and corresponding tests are updated to include and validate this new feature flag.

Changes

File(s) Change Summary
docker-compose.yml Updated Meilisearch image to remove fixed version tag, now using the default (latest) image.
src/types/experimental-features.ts Added optional chatCompletions?: boolean | null to RuntimeTogglableFeatures type.
tests/experimental-features.test.ts Updated tests to include and validate the new chatCompletions feature flag.

Sequence Diagram(s)

sequenceDiagram
  participant TestSuite
  participant FeatureToggles

  TestSuite->>FeatureToggles: Enable all experimental features (including chatCompletions)
  FeatureToggles-->>TestSuite: Features enabled
  TestSuite->>FeatureToggles: Cleanup (set chatCompletions to false)
  FeatureToggles-->>TestSuite: Features reset
Loading

Possibly related PRs

  • Add experimental features methods #1928: Adds methods to get and update experimental features and initially defines the RuntimeTogglableFeatures type, directly related to the extension and management of feature toggles.

Suggested reviewers

  • Strift

Poem

In the warren where features grow,
A toggle for chat now joins the show.
Compose floats free, no version to bind,
While tests ensure nothing’s left behind.
With a hop and a skip, we celebrate anew,
Experimental flags—now one more in the queue! 🐇✨

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

Copy link

codecov bot commented Jul 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.01%. Comparing base (d71244b) to head (9d76fd3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1977   +/-   ##
=======================================
  Coverage   99.01%   99.01%           
=======================================
  Files          18       18           
  Lines        1418     1418           
  Branches      299      299           
=======================================
  Hits         1404     1404           
  Misses         14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d71244b and 9d76fd3.

📒 Files selected for processing (3)
  • docker-compose.yml (1 hunks)
  • src/types/experimental-features.ts (1 hunks)
  • tests/experimental-features.test.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: integration-tests (Node.js 20)
  • GitHub Check: integration-tests (Node.js 22)
🔇 Additional comments (3)
src/types/experimental-features.ts (1)

14-14: LGTM! Consistent with existing experimental features.

The new chatCompletions property follows the same pattern as other experimental features in the type definition.

tests/experimental-features.test.ts (2)

16-16: LGTM! Proper test cleanup implementation.

The new feature flag is correctly included in the cleanup step to ensure tests don't leave side effects.


29-29: LGTM! Complete test coverage for the new feature.

The chatCompletions feature is properly included in the test case that validates all experimental features, ensuring comprehensive coverage.

@@ -14,7 +14,7 @@ services:
- ./:/home/package

meilisearch:
image: getmeili/meilisearch:v1.15.0
image: getmeili/meilisearch
Copy link

@coderabbitai coderabbitai bot Jul 1, 2025

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Avoid using latest tag - pin to specific version for reproducibility.

Removing the version pin introduces several risks:

  • Different developers may pull different Meilisearch versions
  • CI/CD builds become non-reproducible
  • Potential breaking changes from newer versions
  • No guarantee the latest version is compatible with current code

Consider pinning to a specific recent version instead:

-    image: getmeili/meilisearch
+    image: getmeili/meilisearch:v1.16.0

Please verify the latest compatible Meilisearch version and test the integration:


🌐 Web query:

What is the latest stable version of Meilisearch and are there any breaking changes since v1.15.0?

💡 Result:

The latest stable version of Meilisearch is v1.15, released on June 9, 2025[5][10]. This release introduces several new features and improvements.

Key new features in Meilisearch v1.15:

  • Disable typo tolerance for numbers: You can now turn off typo tolerance for numeric values using the typoTolerance.disableOnNumbers setting. This ensures precise matching of numbers (e.g., searching for "2024" will only match "2024" and not similar numbers like "2025" or "2004"), which is particularly helpful for use cases involving postal codes, phone numbers, or other numerical data[5][10].
  • Lexicographic string filters: This release adds support for comparison operators (<, <=, >, >=, TO) for strings, enabling lexicographic filtering. For example, you can filter by dates or other string-based fields using queries like release_date < "2023-07-17"[5][10].
  • Improved support for Chinese: Enhancements for Chinese language processing have been included[5].

Breaking changes since v1.15.0:

  • According to the official Meilisearch v1.15 release notes and changelog, no major breaking changes are mentioned for v1.15 itself—most updates are feature additions and improvements[5][10].
  • Looking at previous recent versions, significant breaking changes affecting AI-powered search were introduced in v1.13, particularly for Ollama URL handling and error code modifications. These would be relevant to users upgrading from before v1.13[4].

Summary Table: Version and Breaking Changes

Version Release Date Notable Breaking Changes
v1.15 2025-06-09 None listed for core usage; mostly new features/improvements
v1.14 2025-04-14 New experimental features (no core-breaking changes noted)
v1.13 2025-02-17 Breaking changes in AI search (embedding endpoints, error codes)[4]

If upgrading from v1.14 or earlier to v1.15, you should review the changelog for v1.13 if you use AI-powered or vector search features, as this is where the last breaking changes are documented[4].

For most users upgrading from v1.15.0 to the very latest v1.15.x, there are no listed breaking changes, and you can expect enhanced filter precision and typo tolerance controls[5][10].

Citations:


Pin the MeiliSearch image to a specific version for reproducibility.

Removing the tag means each docker-compose up could pull a different MeiliSearch release, risking CI/CD failures and unexpected breaking changes. The latest stable release is v1.15 (June 9, 2025), with no breaking changes since v1.15.0.

• Update docker-compose.yml at line 17:

-    image: getmeili/meilisearch
+    image: getmeili/meilisearch:v1.15.0

• Run your integration tests to confirm compatibility with v1.15.0.

📝 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
image: getmeili/meilisearch
image: getmeili/meilisearch:v1.15.0
🤖 Prompt for AI Agents
In docker-compose.yml at line 17, the MeiliSearch image is not pinned to a
specific version, which can cause inconsistent builds. Update the image tag from
'getmeili/meilisearch' to 'getmeili/meilisearch:v1.15.0' to ensure
reproducibility. After updating, run your integration tests to verify
compatibility with version v1.15.0.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

workflows already use latest meilisearch for testing (image: getmeili/meilisearch:latest) so until that changes this should also be latest

Copy link

Choose a reason for hiding this comment

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

🧩 Analysis chain

@flevi29 Thank you for the clarification! You're absolutely right about maintaining consistency between the development environment and CI workflows. I can see that using latest aligns with your testing strategy.

Your approach of keeping the docker-compose.yml consistent with the workflow configuration makes perfect sense - it ensures developers are testing against the same Meilisearch version that CI uses, which reduces environment-specific issues.

(\ /)
( .. )
o
(")-("
Understanding nod


🏁 Script executed:

#!/bin/bash
# Search for workflow files to verify the claim about using latest Meilisearch
fd -e yml -e yaml . | grep -E "(workflow|\.github)" | head -10

# Search for Meilisearch image usage in workflow files
rg "getmeili/meilisearch" --type yaml -A 2 -B 2

Length of output: 286


🏁 Script executed:

#!/bin/bash
# Search more broadly for GitHub workflow files
find . -name "*.yml" -o -name "*.yaml" | head -20

# Look specifically for .github directory
ls -la | grep github

# Search for any meilisearch references in all YAML files
rg -i "meilisearch" --type yaml -A 2 -B 2

Length of output: 5336


🏁 Script executed:

#!/bin/bash
# Search for Meilisearch usage in workflow files specifically
rg -i "meilisearch" .github/workflows/ -A 2 -B 2

# Also search for any Docker image references in workflows
rg "image:" .github/workflows/ -A 1 -B 1

Length of output: 7911


@flevi29 Perfect! You're absolutely right. I can now see that the main testing workflow in .github/workflows/tests.yml does indeed use getmeili/meilisearch:latest:

services:
  meilisearch:
    image: getmeili/meilisearch:latest

Your decision to keep consistency between the docker-compose.yml and the workflow configuration makes complete sense. This ensures that:

  1. Developers testing locally get the same Meilisearch version as CI
  2. Integration issues are caught early
  3. There's no version drift between development and testing environments

I apologize for my initial suggestion to pin the version - you have a well-thought-out strategy here that prioritizes consistency across your testing environments. Thank you for the clarification!

(\ /)
( .. )
o
(")-("
Appreciative nod


✏️ Learnings added
Learnt from: flevi29
PR: meilisearch/meilisearch-js#1977
File: docker-compose.yml:17-17
Timestamp: 2025-07-01T08:07:25.020Z
Learning: In the meilisearch-js project, both the docker-compose.yml and CI workflows use the latest Meilisearch image (getmeili/meilisearch:latest) for consistency between development and testing environments.

Learnt from: flevi29
PR: meilisearch/meilisearch-js#1977
File: docker-compose.yml:17-17
Timestamp: 2025-07-01T08:07:25.020Z
Learning: In the meilisearch-js project, both the docker-compose.yml and the main CI workflow (.github/workflows/tests.yml) use `getmeili/meilisearch:latest` to maintain consistency between local development and CI testing environments.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

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

Successfully merging this pull request may close these issues.

1 participant