fix(schema): Provide a truncated name for unique constraints with polymorphic fk

[diesal11]

fixes #1992

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the logic in the PrismaSchemaGenerator class, specifically in the replicateForeignKeyModelLevelUnique method. The changes enforce an explicit type check that throws a PluginError if the argument is not a reference, and they replace the original foreign key with a new one when appropriate. In addition, field names are now collected to generate a unique constraint name for the model attribute. A new regression test file (issue-1992.test.ts) has also been added to verify schema loading with multiple models, enums, and unique constraints using a PostgreSQL provider.

Changes

File(s)	Change Summary
packages/.../schema-generator.ts	Modified replicateForeignKeyModelLevelUnique to: - Throw PluginError if the argument is not a ReferenceExpr - Replace the foreign key reference when applicable - Collect field names to generate a unique constraint name and pass it to model.addAttribute
tests/regression/tests/issue-1992.test.ts	Added a regression test that loads a schema consisting of multiple models, an enum, and unique constraints using @zenstackhq/testtools with a PostgreSQL provider.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Generator as PrismaSchemaGenerator
    participant Model as Model

    Caller->>Generator: Call replicateForeignKeyModelLevelUnique(model, dataModel, origForeignKey, addedFkField)
    Generator->>Generator: Check if argument is a ReferenceExpr
    alt Argument is not a ReferenceExpr
        Generator-->>Caller: Throw PluginError
    else Argument is ReferenceExpr
        Generator->>Generator: Replace original foreign key with new field name
        Generator->>Generator: Collect field names for constraint naming
        Generator->>Model: Invoke model.addAttribute(uniqueConstraint)
        Generator-->>Caller: Return updated model
    end

Loading

Possibly related PRs

• fix: polymorphic logical Prisma schema has identifiers with too long names #1482: The changes in the main PR regarding the replicateForeignKeyModelLevelUnique method in the PrismaSchemaGenerator class are related to the modifications in the same class in the retrieved PR, which also involves refactoring of foreign key replication logic.
• fix: Validation error when @@unique attribute is defined in the different model of the relation field #1430: The changes in the main PR regarding unique constraints in the PrismaSchemaGenerator class are related to the adjustments made in the retrieved PR's DataModelValidator, as both involve handling unique constraints in the context of model relationships.
• fix(delegate): generated logical prisma schema has errors when abstra… #1490: The changes in the main PR regarding the replicateForeignKeyModelLevelUnique method in the PrismaSchemaGenerator class are related to the modifications in the same class within the retrieved PR, which also involves refining logic for processing fields, particularly in handling inherited fields.

Suggested reviewers

• ymc9

---

📜 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 9252250 and f4fdb1a.

📒 Files selected for processing (2)

• packages/schema/src/plugins/prisma/schema-generator.ts (2 hunks)
• tests/regression/tests/issue-1992.test.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• tests/regression/tests/issue-1992.test.ts

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

• packages/schema/src/plugins/prisma/schema-generator.ts

---

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 317f535 and 9252250.

📒 Files selected for processing (2)

• packages/schema/src/plugins/prisma/schema-generator.ts (2 hunks)
• tests/regression/tests/issue-1992.test.ts (1 hunks)

🔇 Additional comments (3)

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

52-53: LGTM! The unique constraints are well-defined.

The test correctly verifies the unique constraints on the MyAppUserFolder model:

• @@unique([companyId, userId, name]): Ensures unique folder names per user within a company.
• @@unique([companyId, userId, path]): Ensures unique paths per user within a company.

packages/schema/src/plugins/prisma/schema-generator.ts (2)

533-536: LGTM! Improved error handling with explicit type check.

The code now explicitly checks for unexpected field references in the @@unique attribute, which helps catch potential issues early.

---

558-562: LGTM! Improved unique constraint name generation.

The code now:

1. Collects field names to generate a descriptive constraint name.
2. Uses the truncate method to ensure the name fits within database limits.
3. Adds the constraint name to the unique attribute using the map argument.

[ymc9]

Looks great to me! Thank you!