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(delegate): deleteMany fails when the model has compound id fields #2004

Merged
merged 2 commits into from
Feb 23, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Feb 23, 2025

fixes #1998

Copy link
Contributor

coderabbitai bot commented Feb 23, 2025

📝 Walkthrough

Walkthrough

This pull request updates the deletion logic in the DelegateProxyHandler class to correctly handle entities with compound primary keys. The methods doDeleteMany and deleteBaseRecursively now check if an entity has multiple keys and use the composeCompoundUniqueField utility to build the proper deletion filter. Additionally, a new regression test file has been added to verify deletion permissions for entity relationships based on their updatable attribute.

Changes

File(s) Change Summary
packages/.../delegate.ts Updated deletion methods (doDeleteMany, deleteBaseRecursively) to check for compound primary keys and generate appropriate filters using a utility.
tests/.../issue-1998.test.ts Added a regression test to validate entity relationships and deletion behavior based on the updatable property of the involved entities.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Delegate as DelegateProxyHandler
    participant Utility as ComposeCompoundUniqueField
    participant DB as Database

    Client->>Delegate: Request deletion (doDeleteMany or deleteBaseRecursively)
    Delegate->>Delegate: Check for compound primary keys
    alt Compound keys detected
        Delegate->>Utility: Generate compound key filter
        Utility-->>Delegate: Return compound filter
    else Simple key detected
        Delegate->>Delegate: Create simple key filter
    end
    Delegate->>DB: Execute deletion with filter (doDelete)
    DB-->>Delegate: Return result
    Delegate-->>Client: Forward deletion outcome
Loading

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 d42dc32 and 7b7cb66.

📒 Files selected for processing (2)
  • packages/runtime/src/enhancements/node/delegate.ts (1 hunks)
  • tests/regression/tests/issue-1998.test.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build-test (20.x)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: build-test (20.x)
  • GitHub Check: dependency-review
  • GitHub Check: build-test (20.x)
🔇 Additional comments (5)
packages/runtime/src/enhancements/node/delegate.ts (2)

1109-1120: Good handling of compound IDs in bulk deletions.

By delegating deletion logic to doDelete with a composed unique filter when multiple ID keys exist, you correctly accommodate models featuring compound primary keys. The parallel execution using Promise.all also helps reduce I/O latency. As an optional improvement, be mindful of transactional boundaries (if partial failures occur) and possible performance bottlenecks when deleting a large number of entities.


1128-1133: Consistent approach for recursively deleting base entities.

This conditional check for compound ID fields mirrors the logic used in doDeleteMany, ensuring that base models with multiple ID fields are handled properly. It's coherent and maintains consistency with the compound-delete strategy.

tests/regression/tests/issue-1998.test.ts (3)

5-36: Schema definition appears comprehensive.

Defining @@delegate(type), @@allow, and discriminators for models Entity, A, and B, along with the many-to-many Relation model containing a compound ID, verifies the core scenario for issue #1998. This setup provides strong coverage of the inheritance and extended entity relationships.


40-49: Successful relation deletion scenario is well-validated.

Creating A and B entities with updatable = true and then verifying that deleteMany({ parentId, childId }) returns a count of 1 aligns with the @@allow('delete', ...) logic. This test ensures correct permission evaluation under normal conditions.


50-58: Properly checks that non-updatable entities deny deletions.

Confirming a count of 0 for the deleteMany call when updatable = false ensures that the permission rule @@allow('delete', check(parent, 'update') && check(child, 'update')) is enforced. This negative test scenario helps confirm issue #1998’s fix remains robust.

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

‼️ 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. (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.

@ymc9 ymc9 merged commit 54a9b21 into dev Feb 23, 2025
11 checks passed
@ymc9 ymc9 deleted the fix/issue-1998 branch February 23, 2025 23:50
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