feat: allow to pass in a custom Prisma module when calling enhance

[ymc9]

Summary by CodeRabbit

• New Features
  • Introduced an enhancement in policy handling capabilities, allowing for more flexible and customizable policy enforcement.
  • Added new configuration options to improve the functionality and customization of error handling.
• Refactor
  • Updated several internal methods to utilize new enhancement options, ensuring more robust and configurable error management.
• Tests
  • Expanded integration tests to cover new enhancement functionalities, ensuring reliability and performance.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates focus on enhancing policy handling and error management in the runtime package by integrating EnhancementOptions throughout various components. It involves adding a new prismaModule option to the common enhancement options, updating functions to accept an options parameter for better customization, and refining integration tests. These changes aim to improve flexibility and functionality in policy enforcement and error handling within the framework.

Changes

Files	Change Summary
.../policy/handler.ts, .../policy/policy-utils.ts	- Introduced WithPolicyOptions import. - Updated method calls to include this.options. - Added this.options in constructor and method parameters. - Imported EnhancementOptions. - Added `options: EnhancementOptions
.../enhancements/types.ts	- Added prismaModule as an optional property to CommonEnhancementOptions.
.../enhancements/utils.ts	- Updated prismaClientValidationError, prismaClientKnownRequestError, and prismaClientUnknownRequestError to accept an additional options parameter of type EnhancementOptions.
tests/integration/tests/enhancements/with-policy/options.test.ts	- Replaced withPolicy function usage with enhance. - Added tests for data creation under specific conditions. - Integrated modelMeta, policy, and prismaModule parameters in enhance function calls.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 269809a and 4297df9.

Files selected for processing (5)

• packages/runtime/src/enhancements/policy/handler.ts (13 hunks)
• packages/runtime/src/enhancements/policy/policy-utils.ts (3 hunks)
• packages/runtime/src/enhancements/types.ts (1 hunks)
• packages/runtime/src/enhancements/utils.ts (2 hunks)
• tests/integration/tests/enhancements/with-policy/options.test.ts (3 hunks)

Files not reviewed due to errors (1)

• (no review received)

Additional comments: 8

tests/integration/tests/enhancements/with-policy/options.test.ts (2)

• 29-29: The enhance function is called with undefined as the second argument, which seems to be a placeholder for future options. Consider documenting this choice or providing a comment for clarity.
• 54-54: Using a custom Prisma module in the enhance function call demonstrates the new functionality well. Ensure that the Prisma module passed here is correctly instantiated and matches the expected type.

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

• 57-61: The addition of the options parameter to prismaClientValidationError and its use to optionally load a custom Prisma module is a good implementation of the new feature. Ensure that the EnhancementOptions type correctly defines the prismaModule property and that error handling is robust.
• 69-73: Similar to prismaClientValidationError, the update to prismaClientKnownRequestError to accept an options parameter enhances the function's flexibility. Verify that the rest of the codebase correctly passes this parameter where these functions are used.
• 81-85: The update to prismaClientUnknownRequestError follows the same pattern as the previous functions, correctly implementing the new functionality. Consistency in handling the options parameter across these functions is key to the feature's success.

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

• 8-8: The import of EnhancementOptions is correctly added to support the new functionality.
• 52-52: The addition of the options parameter to the PolicyUtil constructor is correctly implemented to support enhancement options. Consider adding documentation comments for the new parameter to explain its purpose and usage.
• 1103-1103: The updates to method calls to include this.options are correctly implemented, ensuring that utility functions can utilize the new enhancement options. Verify that all relevant methods have been updated to pass this.options where necessary.

Also applies to: 1110-1110, 1117-1117, 1121-1121