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): improved query reduction to workaround Prisma issue prisma/prisma#21856 #1634

Merged
merged 2 commits into from
Aug 4, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Aug 4, 2024

Prisma issue: prisma/prisma#21856

Fixes #1627

Copy link
Contributor

coderabbitai bot commented Aug 4, 2024

Walkthrough

Walkthrough

The recent changes introduce a new Jest configuration for the runtime package, enhance the PolicyUtil class to accommodate null values and improve condition handling, reorganize import paths for better clarity, and add comprehensive tests to validate the functionality of logical reductions in policy processing. Additionally, a regression test is included to address a specific issue related to user access control in the schema.

Changes

File Path Change Summary
packages/runtime/jest.config.ts New Jest configuration file that imports settings from a parent config, ensuring consistent testing practices across modules.
packages/runtime/src/enhancements/policy/policy-utils.ts Enhanced isTrue and isFalse methods in PolicyUtil to accept null/undefined values and refined logic for evaluating conditions.
packages/runtime/src/enhancements/utils.ts Modified import statements to reorganize module structure without changing logic or functionality.
packages/runtime/tests/policy/reduction.test.ts New test file providing extensive unit tests for the reduce function in PolicyUtil, ensuring correct behavior for various query scenarios.
tests/regression/tests/issue-1627.test.ts New regression test focusing on user access control in the schema, validating model relationships and ensuring unauthorized access is prevented.

Assessment against linked issues

Objective Addressed Explanation
Unauthenticated users can read from tables (issue #1627)
Ensure policy checks function correctly for user roles and access levels.

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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba8a888 and acf95b2.

Files selected for processing (5)
  • packages/runtime/jest.config.ts (1 hunks)
  • packages/runtime/src/enhancements/policy/policy-utils.ts (5 hunks)
  • packages/runtime/src/enhancements/utils.ts (1 hunks)
  • packages/runtime/tests/policy/reduction.test.ts (1 hunks)
  • tests/regression/tests/issue-1627.test.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • packages/runtime/jest.config.ts
  • packages/runtime/src/enhancements/utils.ts
Additional comments not posted (11)
tests/regression/tests/issue-1627.test.ts (1)

1-50: LGTM!

The regression test for issue #1627 is well-structured and covers the necessary steps to validate the issue. The schema loading, data creation, and final assertion are appropriate.

packages/runtime/tests/policy/reduction.test.ts (7)

1-8: LGTM!

The test setup for the PolicyUtil class's query reduction logic is appropriate. The reduce function is correctly instantiated and used.


10-32: LGTM!

The tests for handling regular queries and logical queries are comprehensive and cover various scenarios. The assertions validate the expected behavior of the reduce method.


34-39: LGTM!

The tests for handling constant true/false conditions are appropriate and validate the expected behavior of the reduce method.


41-48: LGTM!

The tests for reducing simple true/false conditions are comprehensive and validate the expected behavior of the reduce method.


50-54: LGTM!

The tests for reducing AND queries are appropriate and validate the expected behavior of the reduce method.


56-60: LGTM!

The tests for reducing OR queries are appropriate and validate the expected behavior of the reduce method.


62-65: LGTM!

The tests for reducing NOT queries are appropriate and validate the expected behavior of the reduce method.

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

111-115: LGTM!

The singleKey method is straightforward and correctly implemented.


119-144: LGTM!

The enhancements to the isTrue method are well-implemented and improve its robustness. The method now correctly handles null values and specific structures within the condition object.


147-167: LGTM!

The enhancements to the isFalse method are well-implemented and improve its robustness. The method now correctly handles null values and specific structures within the condition object.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between acf95b2 and 4d9a2d7.

Files selected for processing (1)
  • packages/runtime/tests/policy/reduction.test.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/runtime/tests/policy/reduction.test.ts

@ymc9 ymc9 merged commit 179634e into dev Aug 4, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1627 branch August 4, 2024 14:51
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