Skip to content
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

fix: accept and convert in operator arrays #374

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

rsodre
Copy link
Contributor

@rsodre rsodre commented Jan 13, 2025

Closes #351, fixed #364

Introduced changes

  • Accept arrays as values for the $in operator
  • Convert array values to List primitive

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Add a dedicated CI job for new examples
  • Performed self-review of the code

Summary by CodeRabbit

  • New Features

    • Enhanced query filtering capabilities by adding support for $in and $nin operators
    • Improved array value handling in query conversion process
  • Improvements

    • Expanded type definitions to support more complex query conditions
    • Added ability to filter values based on list membership

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request introduces enhancements to the SDK's query capabilities by adding support for $in and $nin operators. In the types.ts file, new optional properties are added to the WhereCondition<TModel> type to enable filtering based on array membership. Additionally, the convertQuerytoClause.ts file is modified to handle array values during primitive type conversion, improving the SDK's flexibility in processing complex query conditions.

Changes

File Change Summary
packages/sdk/src/types.ts Added $in and $nin optional properties to WhereCondition<TModel> type for array-based filtering
packages/sdk/src/convertQuerytoClause.ts Enhanced convertToPrimitive function to handle array values by mapping and converting array items

Assessment against linked issues

Objective Addressed Explanation
Support $in filter for querying [#351, #364]
Enable more flexible entity querying [#351]
Add advanced filtering options [#364]

Poem

🐰 Hop, hop, through the code we go,
Arrays now dance, queries flow!
$in and $nin, filters so bright,
SDK's power takes a playful flight! 🚀
Rabbit's magic makes data take flight! 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Sorry, something went wrong.

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: 0

🧹 Nitpick comments (2)
packages/sdk/src/types.ts (1)

104-105: Add JSDoc comments for new operators.

The implementation looks good, but please add documentation for the new operators to maintain consistency with other operators and improve developer experience.

           $lt?: TModel[P];
           $lte?: TModel[P];
+          /** Matches values that are in the specified array */
           $in?: TModel[P][];
+          /** Matches values that are not in the specified array */
           $nin?: TModel[P][];
packages/sdk/src/convertQuerytoClause.ts (1)

298-299: PR objectives successfully achieved.

The implementation successfully:

  1. Accepts arrays as valid input values for the $in operator
  2. Converts array values to the List primitive type
  3. Provides additional support for the $nin operator

Consider adding examples to the documentation to showcase the new array filtering capabilities.

Also applies to: 104-105

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a50c3d1 and 48f5f3c.

📒 Files selected for processing (2)
  • packages/sdk/src/convertQuerytoClause.ts (1 hunks)
  • packages/sdk/src/types.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: check
  • GitHub Check: build
🔇 Additional comments (2)
packages/sdk/src/convertQuerytoClause.ts (2)

298-299: Integration between types and implementation looks good!

The array handling implementation in convertQuerytoClause.ts correctly supports the new $in and $nin operators defined in types.ts. The type safety is maintained throughout the conversion process.

Also applies to: 104-105


298-299: Add validation for array inputs.

While the implementation works for basic arrays, consider adding validation for:

  1. Empty arrays
  2. Nested arrays
  3. Array size limits to prevent performance issues with very large arrays
     } else if (Array.isArray(value)) {
+        if (value.length === 0) {
+            throw new Error('Empty arrays are not supported');
+        }
+        if (value.length > 1000) {
+            throw new Error('Arrays exceeding 1000 elements are not supported');
+        }
+        if (value.some(item => Array.isArray(item))) {
+            throw new Error('Nested arrays are not supported');
+        }
         return { List: value.map((item) => convertToPrimitive(item)) };
     }

Let's verify the current usage patterns to determine appropriate size limits:

@MartianGreed MartianGreed merged commit 57b923a into dojoengine:main Jan 14, 2025
5 checks passed
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.

[Feature]: Sorting and $in where filter
2 participants