Skip to content

fix(policy): Prisma extension computed fields are not returned when fields level polices are used #2125

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 2 commits into from
May 20, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented May 20, 2025

fixes #2117

Copy link
Contributor

coderabbitai bot commented May 20, 2025

📝 Walkthrough

Walkthrough

The doInjectReadCheckSelect function in policy-utils.ts was refactored to streamline the logic for injecting field selections required for read policy checks, particularly in handling scalar and relation fields. Additionally, a new regression test was added to verify correct selection and inclusion of Prisma extension computed fields under policy rules.

Changes

File(s) Change Summary
packages/runtime/src/enhancements/node/policy/policy-utils.ts Refactored doInjectReadCheckSelect to simplify injection logic for scalar and relation fields, removing legacy branching.
tests/regression/tests/issue-2117.test.ts Added regression test for issue 2117 to validate computed field selection with Prisma client extensions and policy rules.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Regression Test
    participant Prisma as Prisma Client (Extended)
    participant Policy as Policy Layer

    Test->>Prisma: Create user record
    Test->>Prisma: Query user (all fields)
    Prisma->>Policy: Apply read policy checks
    Policy->>Prisma: Inject required fields (including computed)
    Prisma-->>Test: Return user with computed field

    Test->>Prisma: Query user (select email only)
    Prisma->>Policy: Apply read policy checks
    Policy->>Prisma: Inject required fields for policy
    Prisma-->>Test: Return user with only email field
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure computed fields from Prisma extensions are included in select when required by field-level policies (#2117)
Regression test to verify correct selection and behavior for computed fields under policy rules (#2117)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 00344ad and 154f474.

📒 Files selected for processing (2)
  • packages/runtime/src/enhancements/node/policy/policy-utils.ts (1 hunks)
  • tests/regression/tests/issue-2117.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
tests/regression/tests/issue-2117.test.ts (1)
packages/testtools/src/schema.ts (1)
  • loadSchema (163-369)
packages/runtime/src/enhancements/node/policy/policy-utils.ts (1)
packages/runtime/src/cross/model-meta.ts (1)
  • resolveField (213-221)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build-test (20.x)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: dependency-review
  • GitHub Check: build-test (20.x)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: build-test (20.x)
🔇 Additional comments (2)
packages/runtime/src/enhancements/node/policy/policy-utils.ts (1)

1207-1243: Improved field selection logic for computed fields.

The refactored implementation smartly separates scalar and relation field processing, making the code more maintainable and fixing the issue with Prisma extension computed fields under field-level policies.

Key improvements:

  • Only adds scalar fields to selection if args.select exists without args.include
  • More consistent handling of relation fields by recursively passing the correct nested args
  • Removes previous complexity by relying on presence/absence of selection targets
tests/regression/tests/issue-2117.test.ts (1)

1-44: Good regression test for computed fields with field-level policies.

This test properly verifies the fix for issue #2117 by:

  1. Defining a schema with field-level policies
  2. Adding a computed field via Prisma extension
  3. Testing both full and selective field queries

Particularly good is checking that pageUrl is correctly included in full queries (line 36) but excluded when using selective field queries (line 41).

✨ 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 3ce431f into dev May 20, 2025
11 checks passed
@ymc9 ymc9 deleted the fix/issue-2104 branch May 20, 2025 18:46
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