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

feat: support updateManyAndReturn #1960

Merged
merged 3 commits into from
Jan 14, 2025
Merged

feat: support updateManyAndReturn #1960

merged 3 commits into from
Jan 14, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jan 14, 2025

No description provided.

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

This pull request introduces support for the updateManyAndReturn action across multiple files in the runtime package. The changes involve adding the new action to constants, type definitions, and implementing the corresponding logic in proxy handlers and policy handlers. The modifications enable a new database operation that allows updating multiple records and returning their updated state, with comprehensive policy and permission checks integrated into the implementation.

Changes

File Change Summary
packages/runtime/src/constants.ts Added 'updateManyAndReturn' to ACTIONS_WITH_WRITE_PAYLOAD constant
packages/runtime/src/cross/nested-write-visitor.ts Added updateManyAndReturn case in doVisit method of NestedWriteVisitor
packages/runtime/src/cross/types.ts Included 'updateManyAndReturn' in PrismaWriteActions constant
packages/runtime/src/enhancements/node/policy/handler.ts Implemented updateMany and updateManyAndReturn methods in PolicyProxyHandler
packages/runtime/src/enhancements/node/proxy.ts Added updateManyAndReturn method to PrismaProxyHandler interface and DefaultPrismaProxyHandler
packages/runtime/src/types.ts Added updateManyAndReturn method to DbOperations interface

Sequence Diagram

sequenceDiagram
    participant Client
    participant ProxyHandler
    participant PolicyHandler
    participant Database
    
    Client->>ProxyHandler: updateManyAndReturn(args)
    ProxyHandler->>PolicyHandler: Apply policy checks
    PolicyHandler-->>ProxyHandler: Policy validation result
    ProxyHandler->>Database: Execute update operation
    Database-->>ProxyHandler: Return updated records
    ProxyHandler-->>Client: Return updated records
Loading

Possibly related PRs

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.

Copy link
Contributor

@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 (5)
tests/regression/tests/issue-1955.test.ts (1)

106-115: Consider adding more diverse test cases

While the current test verifies basic functionality, consider adding test cases for:

  • Partial updates
  • Different where conditions
  • Error scenarios
tests/integration/tests/enhancements/with-policy/update-many-and-return.test.ts (1)

106-139: LGTM! Well-structured field-level policy tests

Good coverage of field-level permissions and partial visibility scenarios.

Consider adding test cases for:

  • Error handling when policies are violated
  • Invalid update data scenarios
  • Concurrent update scenarios
packages/runtime/src/enhancements/node/policy/handler.ts (3)

1278-1278: Add return type annotation to doUpdateMany.

The method's return type should be explicitly annotated for better type safety and documentation.

-    private doUpdateMany(args: any, action: 'updateMany' | 'updateManyAndReturn'): Promise<any> {
+    private doUpdateMany(args: any, action: 'updateMany' | 'updateManyAndReturn'): Promise<{ count: number } | unknown[]> {

1331-1332: Fix comment typo in error handling.

The error message refers to "create result" but should refer to "update result".

-                    // throw read-back error if any of create result read-back fails
+                    // throw read-back error if any of the update result read-back fails

1314-1338: Consider extracting transaction-less and transaction paths into separate methods.

The logic for handling transaction-less and transaction paths could be clearer if extracted into separate private methods. This would improve readability and make the code structure more maintainable.

Example structure:

private async handleTransactionLessPath(args: any, action: 'updateMany' | 'updateManyAndReturn', origArgs?: any) {
    // ... transaction-less logic ...
}

private async handleTransactionPath(args: any, action: 'updateMany' | 'updateManyAndReturn', origArgs?: any) {
    // ... transaction logic ...
}

Also applies to: 1389-1407

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9a55cbc and ea6d16b.

📒 Files selected for processing (8)
  • packages/runtime/src/constants.ts (1 hunks)
  • packages/runtime/src/cross/nested-write-visitor.ts (1 hunks)
  • packages/runtime/src/cross/types.ts (1 hunks)
  • packages/runtime/src/enhancements/node/policy/handler.ts (5 hunks)
  • packages/runtime/src/enhancements/node/proxy.ts (2 hunks)
  • packages/runtime/src/types.ts (1 hunks)
  • tests/integration/tests/enhancements/with-policy/update-many-and-return.test.ts (1 hunks)
  • tests/regression/tests/issue-1955.test.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
🔇 Additional comments (10)
packages/runtime/src/cross/types.ts (1)

11-11: LGTM! Addition of updateManyAndReturn action

The new action is correctly added to PrismaWriteActions and maintains logical grouping with other update operations.

packages/runtime/src/constants.ts (1)

80-80: LGTM! Consistent addition to write payload actions

The new action is correctly added to ACTIONS_WITH_WRITE_PAYLOAD, maintaining consistency with other update operations that return results.

tests/regression/tests/issue-1955.test.ts (1)

43-52: LGTM! Basic updateManyAndReturn test coverage

The test properly verifies the basic functionality of updating and returning multiple records.

tests/integration/tests/enhancements/with-policy/update-many-and-return.test.ts (1)

4-104: LGTM! Comprehensive model-level policy testing

Excellent test coverage including:

  • Policy-based update restrictions
  • Read-back policy enforcement
  • Relation handling and filtering
packages/runtime/src/types.ts (1)

22-22: LGTM!

The method signature is consistent with other similar methods in the interface, particularly matching the pattern of createManyAndReturn.

packages/runtime/src/cross/nested-write-visitor.ts (1)

250-250: LGTM!

Correctly reuses the same visitor logic as updateMany since both operations share the same write payload structure. The difference in return value is appropriately handled at the proxy handler level.

packages/runtime/src/enhancements/node/proxy.ts (2)

38-39: LGTM!

The method signature in the interface is consistent with other methods and correctly specifies the return type.


137-140: LGTM!

The implementation correctly uses the deferred pattern and matches the interface contract.

packages/runtime/src/enhancements/node/policy/handler.ts (2)

1271-1278: LGTM! Good refactoring.

Extracting shared logic into doUpdateMany improves code maintainability and reduces duplication.


1409-1426: LGTM! Proper error handling.

The read-back processing correctly handles errors and results, ensuring that any failures during the read-back process are properly propagated.

@ymc9 ymc9 merged commit 6e51fbd into dev Jan 14, 2025
9 checks passed
@ymc9 ymc9 deleted the feat/updateManyAndReturn branch January 14, 2025 06:45
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