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

fix(runtime): proxy $extends for each and every enhancement #2016

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

Gabrola
Copy link
Contributor

@Gabrola Gabrola commented Feb 26, 2025

fixes #2014

Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

📝 Walkthrough

Walkthrough

This pull request modifies the proxy creation in the runtime package by simplifying the makeProxy function. The previous conditional check for the PRISMA_PROXY_ENHANCER property has been removed, resulting in every result from the $extends method being wrapped in a new proxy. Additionally, a new regression test has been added which verifies the proper behavior of tenant and user model relationships, as well as the enhancement of the database context using the extended Prisma client.

Changes

File(s) Change Summary
packages/.../node/proxy.ts Modified the makeProxy function to remove the conditional check for PRISMA_PROXY_ENHANCER and always wrap the $extends result in a proxy.
tests/regression/tests/issue-2014.test.ts Added a new regression test validating the tenant-user relationship and the functioning of enhanced/extended Prisma client capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Prisma
    participant ProxyCreator

    Client->>Prisma: Call $extends method
    Prisma-->>Client: Return extension result
    Client->>ProxyCreator: Invoke makeProxy(extension result)
    ProxyCreator-->>Client: Return wrapped proxy
Loading
sequenceDiagram
    participant Test
    participant DB
    participant Enhancer

    Test->>DB: Create Tenant instance
    DB-->>Test: Return Tenant with auto-incrementing id
    Test->>DB: Create User associated with Tenant
    DB-->>Test: Return User with tenantId
    Test->>Enhancer: Enhance User instance using ‘enhance’
    Enhancer->>DB: Extend DB context via $extends (proxy wrapping applied)
    DB-->>Enhancer: Return extended proxy context
    Test->>DB: Create new User through extended context
    DB-->>Test: Return User with expected id and tenantId
Loading

Suggested reviewers

  • ymc9
✨ Finishing Touches
  • 📝 Generate Docstrings

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

1-40: Well-structured regression test

This test effectively validates the fix for issue #2014 by demonstrating that enhancements are properly maintained after extending the database context. The test case covers the tenant-user relationship scenario where the issue was likely encountered.

The test creates a new database context with $extends, then verifies that creating a new user through the extended context correctly preserves the tenant context, showing that the enhancement chain is properly maintained.

One minor suggestion - consider adding a more descriptive test case name that indicates what specific functionality is being tested, for example:

- it('regression', async () => {
+ it('should preserve enhancements after using $extends', async () => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82b8d25 and 2b27224.

📒 Files selected for processing (2)
  • packages/runtime/src/enhancements/node/proxy.ts (1 hunks)
  • tests/regression/tests/issue-2014.test.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build-test (20.x)
  • GitHub Check: dependency-review
  • GitHub Check: OSSAR-Scan
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
🔇 Additional comments (1)
packages/runtime/src/enhancements/node/proxy.ts (1)

263-275: Improved proxy handling for $extends method

This change ensures that every result from the $extends method is wrapped in a proxy, removing the conditional check that was previously present. This is a more robust approach that maintains the enhancement chain in nested operations.

The fix prevents potential issues where enhancements could be lost after applying $extends, which is exactly what issue #2014 was about.

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