fix(polymorphism): createMany is handled incorrectly

[ymc9]

Fixes #1149

Summary by CodeRabbit

• Refactor

  • Improved data handling in delegate functionality by modifying method parameters for enhanced clarity and consistency.

• Tests

  • Added integration tests for polymorphic model creation and relations using enhanced client functionality with delegate support.
  • Introduced a regression test for issue 1149, focusing on CRUD operations with Prisma schema enhancements and delegate functionality.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes focus on enhancing the delegate functionality within a TypeScript project, particularly addressing issues with the createMany and create methods. Modifications include adjusting how data is passed to these methods, ensuring compatibility with polymorphic models and relations, and fixing a specific regression issue. The adjustments aim to improve the functionality and reliability of database operations, especially in the context of using Prisma with schema enhancements.

Changes

Files	Change Summary
packages/runtime/src/enhancements/delegate.ts	Modified doCreate to pass { data: item } instead of item.
tests/integration/tests/enhancements/with-delegate/...	Added test cases for polymorphic models/relations and a regression test for issue 1149.

Assessment against linked issues

Objective	Addressed	Explanation
Identify Issue & Error in db[model].create() invocation (#1149)	✅
Incorrect Data Passing Internally (#1149)	✅
Verification and Workaround (#1149)	❌	The workaround is implemented, but the TypeScript discrepancy is not explicitly addressed in the PR.
TypeScript types associated with createMany might be incorrect (#1149)	❓	The changes suggest an adjustment, but it's unclear if TypeScript type definitions were updated.

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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2d82218 and 390c8b2.

Files selected for processing (3)

• packages/runtime/src/enhancements/delegate.ts (1 hunks)
• tests/integration/tests/enhancements/with-delegate/enhanced-client.test.ts (1 hunks)
• tests/integration/tests/enhancements/with-delegate/issue-1149.test.ts (1 hunks)

Additional comments: 4

tests/integration/tests/enhancements/with-delegate/issue-1149.test.ts (2)

• 1-2: The imports from @zenstackhq/testtools are correctly used for database setup and teardown. This ensures isolation of test environments.
• 7-16: The beforeAll and afterAll hooks are properly used for test setup and teardown. This ensures that the database is created before the tests run and dropped after completion, maintaining a clean state.

packages/runtime/src/enhancements/delegate.ts (1)

• 393-393: The modification to the createMany method to encapsulate each item in the { data: item } structure before calling doCreate is a critical fix for the issue described. This change ensures that data is correctly passed to the create function, aligning with the expected behavior and TypeScript typings.

However, it's important to ensure that this change does not introduce any side effects, especially in scenarios where nested writes or complex data structures are involved. Adding comprehensive test cases covering various use cases of createMany would help verify the correctness and robustness of this fix.

Verification successful

---

The output from the executed script indicates that there are comprehensive test cases covering various use cases of the createMany method across different scenarios, including regression issues, enhancements, and policy enforcement. This suggests that the modification to the createMany method has been adequately tested, addressing the concern raised in the review comment.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that comprehensive test cases covering various use cases of `createMany` are present.
fd '.*\.test\.ts$' --exec grep -Hn 'createMany' {}

Length of output: 3676

tests/integration/tests/enhancements/with-delegate/enhanced-client.test.ts (1)

• 124-140: The test case create many polymorphic model correctly tests the createMany functionality for a single model. However, it's important to ensure that the data passed to createMany is structured correctly according to the expected schema. Specifically, the createMany method expects an array of objects, each representing a record to be created. The test case correctly uses this structure in lines 133-137. This aligns with the PR objectives to fix the createMany functionality and ensure it operates as expected.