fix(runtime): always use id fields to address existing entity during upsert

[ymc9]

Fixes #1271

Summary by CodeRabbit

• New Features
  • Improved update operations accuracy by using correct existing data.
• Tests
  • Added test cases for database operations involving relationships and nested updates.

[coderabbitai]

Walkthrough

Walkthrough

The changes focus on improving database update operations by ensuring accurate data handling and adding tests for upsert operations with compound keys to address relational data integrity and compound key issues in Zenstack.

Changes

File Path	Change Summary
packages/runtime/src/cross/utils.ts	Modified getIdFields function to handle unique constraints and improve model data handling.
packages/runtime/src/enhancements/.../handler.ts	Updated usage of where parameter in doUpdate method for better data accuracy in updates.
packages/sdk/src/model-meta-generator.ts	Refactored getUniqueConstraints function for improved readability and maintainability.
tests/integration/tests/enhancements/...	Added test cases for various update scenarios with multiple ID fields and nested updates.

Assessment against linked issues

Objective	Addressed	Explanation
Upsert operation correctly applying to all specified relations, not just the last one (#1080)	❌	The changes focus on data accuracy and testing upserts but do not directly address nested relation issues.
Resolve error related to generating PrismaClient enhancer with uniqueness constraint issues (#1058)	❌	The PR does not tackle schema generation or uniqueness constraints in relationships as per the linked issue.

Possibly related issues

• Issue Upsert nested relations only applied to the last relation #1080: While the enhanced upsert test could be beneficial, the changes in this PR do not directly target nested relation issues as described in the linked issue.
• Issue Error when generating from schema with polymorphic models - given constraint name ... has to be unique in the following namespace... #1058: The PR does not address schema generation or uniqueness constraints in relationships, hence not directly related to the changes made.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5f7ec29 and 6edfc89.

Files selected for processing (11)

• packages/plugins/swr/tests/test-model-meta.ts (1 hunks)
• packages/plugins/tanstack-query/tests/test-model-meta.ts (1 hunks)
• packages/runtime/src/cross/utils.ts (2 hunks)
• packages/runtime/src/enhancements/policy/handler.ts (7 hunks)
• packages/runtime/src/enhancements/policy/policy-utils.ts (2 hunks)
• packages/sdk/src/model-meta-generator.ts (3 hunks)
• tests/integration/tests/enhancements/with-policy/multi-id-fields.test.ts (10 hunks)
• tests/integration/tests/enhancements/with-policy/nested-to-many.test.ts (1 hunks)
• tests/integration/tests/enhancements/with-policy/nested-to-one.test.ts (1 hunks)
• tests/integration/tests/enhancements/with-policy/toplevel-operations.test.ts (1 hunks)
• tests/integration/tests/regression/issue-1271.test.ts (1 hunks)

Files not reviewed due to errors (1)

• nested-to-many.test.ts (no review received)

Files skipped from review as they are similar to previous changes (2)

• packages/runtime/src/enhancements/policy/handler.ts
• tests/integration/tests/regression/issue-1271.test.ts

Additional comments not posted (8)

packages/plugins/swr/tests/test-model-meta.ts (1)

46-49: Ensure the unique constraints are correctly implemented for user and post.

The addition of unique constraints on the id fields for both user and post entities is a standard practice to ensure data integrity. This change correctly implements these constraints within the modelMeta object.

packages/plugins/tanstack-query/tests/test-model-meta.ts (1)

46-49: Ensure the unique constraints are correctly implemented for user and post.

The addition of unique constraints on the id fields for both user and post entities is a standard practice to ensure data integrity. This change correctly implements these constraints within the modelMeta object.

packages/runtime/src/cross/utils.ts (1)

50-60: Refine the error handling in getIdFields.

Consider providing more detailed error messages that include the model name when no ID fields are found. This can help developers quickly identify which model is causing the issue.

tests/integration/tests/enhancements/with-policy/toplevel-operations.test.ts (1)

150-224: Verify the new test case for updating IDs with policy enforcement.

Ensure that the test case update id tests correctly handles scenarios where updates are denied or successful based on policy conditions. This includes proper handling of upsert operations and their expected outcomes.

tests/integration/tests/enhancements/with-policy/nested-to-one.test.ts (1)

215-271: Verify the new test case for nested update operations with policy enforcement.

Ensure that the test case nested update id tests correctly handles scenarios where nested updates are denied or successful based on policy conditions. This includes proper handling of update operations and their expected outcomes.

tests/integration/tests/enhancements/with-policy/multi-id-fields.test.ts (1)

69-145: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [15-140]

Verify the new test cases for operations involving multiple ID fields.

Ensure that the new test cases for CRUD operations and updates involving multiple ID fields correctly handle scenarios where operations are denied or successful based on policy conditions. This includes proper handling of CRUD operations, nested updates, and their expected outcomes.

Also applies to: 196-221, 227-249, 277-309, 343-416

packages/sdk/src/model-meta-generator.ts (1)

251-295: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [243-292]

Refine the refactoring of getUniqueConstraints.

The refactoring of the getUniqueConstraints function using helper functions extractConstraint and addConstraint improves readability and maintainability. Consider adding more detailed comments explaining the purpose and functionality of these helper functions to aid future developers.

packages/runtime/src/enhancements/policy/policy-utils.ts (1)

572-591: Ensure proper handling of undefined values in composeCompoundUniqueField.

The method composeCompoundUniqueField assumes that all fields in fieldData are defined. Consider adding checks or default values to handle cases where some fields might be undefined or null, which could lead to incorrect behavior or errors.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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]

Fixes #1271