Skip to content

fix: regression with client extension typing #2182

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

Merged
merged 1 commit into from
Jul 14, 2025
Merged

fix: regression with client extension typing #2182

merged 1 commit into from
Jul 14, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jul 14, 2025

fixes #2175

Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

📝 Walkthrough

Walkthrough

The changes update the createLogicalPrismaImports method in the EnhancerGenerator class to select the import path for Prisma internal types based on whether the Prisma client generator is new or legacy. Additionally, new regression tests are added to verify correct type inference and integration when enhancing Prisma clients with extensions.

Changes

File(s) Change Summary
packages/schema/src/plugins/enhancer/enhance/index.ts Modified internal logic in createLogicalPrismaImports to dynamically determine Prisma internal type imports.
tests/regression/tests/issue-2175.test.ts Added regression tests covering schema compilation and Prisma client extension/enhancement integration.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Regression Test
    participant Prisma as PrismaClient (possibly extended)
    participant Enhance as enhance()
    Test->>Prisma: Instantiate PrismaClient (with/without $extends)
    Test->>Enhance: Pass PrismaClient to enhance()
    Enhance->>Prisma: Enhance client (using correct internal type imports)
    Test->>Prisma: Call custom method (e.g., signUp)
    Prisma-->>Test: Return result (with correct typing)
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure type inference is preserved when enhancing a Prisma client that uses extensions (#2175)
Import DynamicClientExtensionThis and related types from correct path based on Prisma generator (#2175)

Possibly related PRs

  • zenstackhq/zenstack#2151: Refactors and adds branching logic in the same class to support both legacy and new Prisma client generators, closely related to import path handling.
  • zenstackhq/zenstack#1808: Modifies the same file and class, focusing on delegate model handling and regex updates, indicating overlap in code area.
  • zenstackhq/zenstack#2171: Also addresses the import path for internal Prisma types in the same method, but with a different (fixed-path) approach.

📜 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 05e8485 and 33744da.

📒 Files selected for processing (2)
  • packages/schema/src/plugins/enhancer/enhance/index.ts (1 hunks)
  • tests/regression/tests/issue-2175.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/regression/tests/issue-2175.test.ts (1)
packages/testtools/src/schema.ts (1)
  • loadSchema (173-379)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: dependency-review
  • GitHub Check: build-test (20.x)
🔇 Additional comments (3)
packages/schema/src/plugins/enhancer/enhance/index.ts (1)

246-253: LGTM! Correct fix for generator-specific import paths.

This change properly addresses the client extension typing regression by dynamically selecting the import path based on the Prisma client generator type. The logic correctly differentiates between new and legacy generators for importing InternalArgs and DynamicClientExtensionThis types.

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

4-54: Good test coverage for standard generator configuration.

This test properly validates the regression fix by:

  • Using default generator configuration (implicit)
  • Testing client extension with custom signUp method
  • Verifying integration with ZenStack's enhance function
  • Using correct import paths for standard generator

56-121: Comprehensive test for new generator configuration.

This test effectively covers the new generator scenario by:

  • Explicitly configuring Prisma client generator with custom output path
  • Testing the same extension/enhancement workflow as the standard test
  • Using appropriate import paths for the custom generator configuration
  • Validating that the typing fix works with both generator types
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@ymc9 ymc9 merged commit 15b13f5 into dev Jul 14, 2025
12 of 13 checks passed
@ymc9 ymc9 deleted the fix/issue-2175 branch July 14, 2025 12:33
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