fix(policy): incorrect field-level permission check for nested create

[ymc9]

fixes #2007

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes enhance the handling of foreign key policy checks within the runtime. In the PolicyProxyHandler and PolicyUtil classes, the methods now extract an explicit list of fields to update (using a new mapping mechanism) instead of relying on the full arguments object. This update affects methods for connecting, updating, and deleting related records, ensuring consistent policy validation. Additionally, a new utility method in QueryUtils extracts defined keys from objects, and regression tests have been added for issue 2007 to validate these changes.

Changes

File(s)	Change Summary
packages/runtime/src/enhancements/node/policy/handler.ts packages/runtime/src/enhancements/node/policy/policy-utils.ts	Updated policy check methods to use explicit fieldsToUpdate arrays instead of full args. Modified logic in methods like connectOrCreate, connect, delete, and deleteMany, and adjusted method signatures in PolicyUtil to focus on defined fields for update and delete operations.
packages/runtime/src/enhancements/node/query-utils.ts	Added new method getFieldsWithDefinedValues(data: object) to filter and return keys with defined values from an input object.
tests/regression/tests/issue-2007.test.ts	Introduced regression tests for issue 2007, verifying that updates involving relations between Page and Image models adhere to the enforced policy constraints.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Handler as PolicyProxyHandler
    participant Util as PolicyUtil
    participant DB as CrudContract

    Client ->> Handler: Request connectOrCreate(model, args)
    Handler ->> Handler: Extract foreign key mappings (fieldsToUpdate)
    Handler ->> Util: checkPolicyForUnique(model, uniqueFilter, operation, DB, fieldsToUpdate)
    Util ->> DB: Execute policy check
    DB -->> Util: Return check result
    Util -->> Handler: Return policy check result
    Handler -->> Client: Proceed with update/create operation

Loading

Possibly related PRs

• fix(policy): update fails for model using both @password and @@validate #2005: Modifies checkPolicyForUnique in the PolicyUtil class, focusing on processing parameters with explicit field mappings similar to this PR.
• fix(policy): relation filter should respect field-level policies #1495: Updates the handling of policy checks in PolicyUtil, aligning with the changes to use defined field arrays for validation.
• fix(policy): only include field selections for evaluating field-level policies if the corresponding fields are selected #1979: Adjusts the logic for policy enforcement by transitioning from full argument checks to a focus on specific update fields, paralleling the modifications in this PR.

---

📜 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 767d59d and 382802d.

📒 Files selected for processing (4)

• packages/runtime/src/enhancements/node/policy/handler.ts (8 hunks)
• packages/runtime/src/enhancements/node/policy/policy-utils.ts (4 hunks)
• packages/runtime/src/enhancements/node/query-utils.ts (1 hunks)
• tests/regression/tests/issue-2007.test.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-test (20.x)
• GitHub Check: build-test (20.x)
• GitHub Check: OSSAR-Scan
• GitHub Check: build-test (20.x)
• GitHub Check: dependency-review
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (8)

packages/runtime/src/enhancements/node/query-utils.ts (1)

257-267: Well-implemented utility method!

The getFieldsWithDefinedValues method is concise, handles edge cases properly, and follows functional programming principles. The implementation efficiently extracts field names with defined values using chained array operations.

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

4-47: Well-structured regression test!

The test effectively validates that an image can be created and subsequently updated to include a related page, even when the id field has an update deny policy. This covers the core functionality needed to verify the fix for issue #2007.

---

49-92: Excellent negative test case!

The test properly validates that updates are rejected when the pageId foreign key field has an update deny policy. This complements the first test case and ensures the policy enforcement works correctly in both permissive and restrictive scenarios.

packages/runtime/src/enhancements/node/policy/policy-utils.ts (2)

836-843: Improved method signature for better clarity!

The checkPolicyForUnique method now accepts fieldsToUpdate instead of args, making it more explicit about which fields are being checked against the policy. This change improves the method's focus and reduces coupling with the args structure.

---

996-1056: Cleaner implementation with better field handling!

The getFieldUpdateGuards method has been improved to work directly with the fields that need to be updated, making it more focused and easier to maintain. The implementation properly handles both scalar and relation fields, with clear separation of concerns.

packages/runtime/src/enhancements/node/policy/handler.ts (3)

287-296: Improved foreign key relationship handling!

The code now correctly maps "connect" operations to their underlying foreign key updates, ensuring accurate policy checks. The comments clearly explain the translation from connect payload to update payload.

---

329-335: Consistent foreign key policy checking!

The implementation aligns well with the connectOrCreate method, properly translating connect operations to their underlying foreign key updates. The comments effectively explain the policy checking logic.

---

1786-1791: Consistent method signature update!

The runPostWriteChecks method has been properly updated to pass an empty array for fieldsToUpdate, which is appropriate for operations like delete that don't involve field updates.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.