Skip to content

fix(rest): multiple relation id filter values are not properly split #2085

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

Merged
merged 1 commit into from
Apr 15, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Apr 15, 2025

fixes #2061

Copy link
Contributor

coderabbitai bot commented Apr 15, 2025

📝 Walkthrough

Walkthrough

The changes update the REST API handler's filter construction logic to support filtering to-one relation fields by multiple IDs. When a filter value for such a field contains multiple comma-separated IDs, the logic now constructs an OR filter with individual ID conditions for each value. Previously, only a single value was supported and multiple values were ignored. A new test case has been added to verify that filtering by a relation field with multiple values returns the expected results.

Changes

File(s) Change Summary
packages/server/src/api/rest/index.ts Modified filter construction logic to support OR filtering for to-one relation fields with multiple IDs.
packages/server/tests/api/rest.test.ts Added a test case to verify filtering on a relation field with multiple values returns correct results.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant REST_API_Handler
    participant Prisma

    Client->>REST_API_Handler: GET /post?filter[author]=user1,user2
    REST_API_Handler->>REST_API_Handler: Parse filter values
    REST_API_Handler->>REST_API_Handler: Construct OR filter for author IDs
    REST_API_Handler->>Prisma: Query posts with OR filter on author
    Prisma-->>REST_API_Handler: Return matching posts
    REST_API_Handler-->>Client: Respond with filtered posts
Loading

Assessment against linked issues

Objective Addressed Explanation
Support filtering on to-one relation fields with multiple values (comma-separated) in REST API (#2061)
Ensure filtering logic matches documentation for multi-value relation filters (#2061)
Add automated test for multi-value relation filtering in REST API (#2061)

Possibly related PRs


📜 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 c58d887 and 0a93a4a.

📒 Files selected for processing (2)
  • packages/server/src/api/rest/index.ts (1 hunks)
  • packages/server/tests/api/rest.test.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
packages/server/src/api/rest/index.ts (1)

1753-1758: Excellent fix for handling multiple relation ID filter values.

The change correctly implements support for filtering to-one relation fields by multiple comma-separated IDs. Instead of treating the entire value as a single filter condition, it now splits by commas and creates an OR condition when multiple values are present, matching behavior with to-many relations.

packages/server/tests/api/rest.test.ts (1)

667-675: Good test coverage for the new functionality.

This test properly verifies that filtering a to-one relation field (author) with multiple comma-separated values (user1,user2) returns the expected combined results from both authors. It confirms that the OR condition is correctly applied.

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

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.
  • @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.

@ymc9 ymc9 merged commit 002e132 into dev Apr 15, 2025
11 checks passed
@ymc9 ymc9 deleted the fix/issue-2016 branch April 15, 2025 03:00
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.

1 participant