Enhance unique index handling in Client class to prevent sparse index…

[shimonewman]

… usage when partialFilterExpression is present

Summary by CodeRabbit

• Bug Fixes
  • Adjusted unique index creation: the sparse option is only applied when no partial filter is provided, preventing conflicts and aligning with expected database behavior.
  • Improves accuracy of index definitions and avoids errors when creating unique indexes with partialFilterExpression.
  • Existing behavior remains unchanged for indexes without partial filters; no configuration changes required.

[coderabbitai]

Walkthrough

Client::createIndexes now conditionally sets sparse => true for unique indexes only when partialFilterExpression is absent. If partialFilterExpression exists, sparse is not set. An explanatory comment was added. No other logic or public interfaces were changed.

Changes

Cohort / File(s)	Summary
Index creation logic src/Client.php	Update createIndexes: for unique indexes, set sparse => true only if partialFilterExpression is not present; add comment explaining the constraint. No API changes.

Sequence Diagram(s)

sequenceDiagram
  actor Caller
  participant Client
  participant MongoDB as MongoDB Server

  Caller->>Client: createIndexes(indexes)
  Client->>Client: For each index:\nif unique==true
  alt unique and no partialFilterExpression
    Client->>Client: add option sparse=true
  else unique with partialFilterExpression
    Client->>Client: do not set sparse
  end
  Client->>MongoDB: send createIndexes command
  MongoDB-->>Client: acknowledgement/result
  Client-->>Caller: return result

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

I twitch my whiskers, tap the keys,
Toggling sparse with expert ease.
“Unique?” I ask. “Filters, too?”
If they’re present, I hop right through.
A tidy patch, concise and neat—
Carrots for code that’s clean and sweet! 🥕✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat-partial-filter-expression

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/Client.php (1)

405-408: Clarify comment and remove stale TODO

The comment still reads like a TODO even though behavior is implemented. Reword it to document the policy and rationale.

Apply this diff to update the comment:

-                /**
-                 * TODO: Unique Indexes are now sparse indexes, which results into incomplete indexes.
-                 * However, if partialFilterExpression is present, we can't use sparse.
-                 */
+                /**
+                 * Note: For unique indexes we default to 'sparse' to avoid uniqueness conflicts on missing fields.
+                 * When 'partialFilterExpression' is present, do not use 'sparse' to avoid conflicts with partial indexes.
+                 */

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4716522 and b2c89d4.

📒 Files selected for processing (1)

• src/Client.php (1 hunks)