fix(delegate): discriminator fields should be removed from unchecked create/update input types

[ymc9]

Fixes #1763

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the EnhancerGenerator class in the packages/schema/src/plugins/enhancer/enhance/index.ts file, updating method signatures and internal logic to enhance the handling of delegate models. The parameter names in specific methods have been changed for clarity, and the logic has been refined to improve the filtering of fields. Additionally, a new regression test suite has been added in tests/regression/tests/issue-1763.test.ts to validate the functionality related to issue 1763, specifically addressing TypeScript errors when creating polymorphic instances.

Changes

File	Change Summary
packages/schema/src/plugins/enhancer/enhance/index.ts	Updated method signatures and internal logic in EnhancerGenerator class to improve handling of delegate models.
tests/regression/tests/issue-1763.test.ts	Introduced a new regression test suite for issue 1763, validating schema functionality and interaction with Prisma.

Assessment against linked issues

Objective	Addressed	Explanation
Typescript should not require a delegation field when creating a new polymorphic instance (1763)	✅

Possibly related PRs

• fix(delegate): avoid merging into object of Decimal, Date, etc. #1489: Addresses issues related to delegates and their interaction with types like Decimal, potentially relevant to the changes in the EnhancerGenerator class.
• fix(delegate): generated logical prisma schema has errors when abstra… #1490: Focuses on fixing errors in the logical Prisma schema involving polymorphic models, which may connect to the changes in how delegate models are processed.
• fix(delegate): null reference when reading an optional relation #1491: Fixes a null reference error when reading optional relations in a polymorphic context, possibly relating to the changes in handling delegate models.
• fix(delegate): concrete model fields are not properly included if queried from a nested context from a parent concrete model #1700: Addresses issues with querying concrete model fields from nested contexts, which may relate to the changes in the EnhancerGenerator class.
• fix(delegate): @omit and field-level policies are not enforced when querying with a delegate model #1718: Ensures that @omit and field-level policies are enforced when querying with delegate models, directly relating to the changes in the EnhancerGenerator.
• fix(delegate): policies inherited from delegate base models are not injected into proper hierarchy #1776: Addresses policy errors with polymorphic models, directly relevant to the changes made regarding the handling of delegate models and their policies.

---

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:

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

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (2)

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

14-15: Security consideration: Review permissive access policy

The comment suggests this is for testing purposes, but the @@allow('all', true) directive grants unrestricted access. In a real application, this would be a security risk.

Consider adding a comment explaining that this permissive policy is specifically for testing:

-    // full access by author
+    // Note: Unrestricted access for testing purposes only. In production, implement proper access controls.
     @@allow('all', true)

packages/schema/src/plugins/enhancer/enhance/index.ts (1)

546-548: Consider simplifying array flattening.

The flatMap usage here can be simplified to flat since you're not transforming the elements.

-        const concreteModelNames = delegateInfo
-            .map(([_, concretes]) => concretes.flatMap((c) => c.name))
-            .flatMap((name) => name);
+        const concreteModelNames = delegateInfo
+            .map(([_, concretes]) => concretes.map((c) => c.name))
+            .flat();

🧰 Tools

🪛 Biome

[error] 546-548: Avoid unnecessary callback in flatMap call.

You can just use flat to flatten the array.
Safe fix: Replace unnecessary flatMap call to flat instead.

(lint/correctness/noFlatMapIdentity)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 74dd0f7 and 5d75fe3.

📒 Files selected for processing (2)

• packages/schema/src/plugins/enhancer/enhance/index.ts (2 hunks)
• tests/regression/tests/issue-1763.test.ts (1 hunks)

🧰 Additional context used

🪛 Biome

packages/schema/src/plugins/enhancer/enhance/index.ts

[error] 546-548: Avoid unnecessary callback in flatMap call.

You can just use flat to flatten the array.
Safe fix: Replace unnecessary flatMap call to flat instead.

(lint/correctness/noFlatMapIdentity)

🔇 Additional comments (4)

tests/regression/tests/issue-1763.test.ts (2)

1-4: LGTM: Test setup follows best practices

The test setup uses the appropriate testing utilities and follows the standard describe/it pattern for regression testing.

---

34-40: Verify error handling for invalid data scenarios

The test only covers the happy path of creating a ConcretePost. Consider adding test cases for:

1. Invalid age values
2. Duplicate IDs
3. Missing required fields

Let's check if there are any other similar test files that might provide coverage for these scenarios:

packages/schema/src/plugins/enhancer/enhance/index.ts (2)

Line range hint 518-533: LGTM! Parameter name change improves clarity.

The renaming from delegateModels to delegateInfo better reflects the data structure being passed, making the code more maintainable.

---

539-553: LGTM! Enhanced regex pattern improves field removal accuracy.

The improved regex pattern now correctly handles both delegate and concrete model names, effectively addressing the issue where TypeScript erroneously requires delegation fields.

🧰 Tools

🪛 Biome

[error] 546-548: Avoid unnecessary callback in flatMap call.

You can just use flat to flatten the array.
Safe fix: Replace unnecessary flatMap call to flat instead.

(lint/correctness/noFlatMapIdentity)