zenstack icon indicating copy to clipboard operation
zenstack copied to clipboard

fix: allow empty expr for dbgenerated() (#1400)

Open clementoriol opened this issue 1 year ago • 1 comments

Hey ! The fix for #1400 seemed easy enough (I mean who get the chance to submit a one char PR ? 😄) so here it goes.

The Prisma docs are not very clear on the subject but dbgenerated() can also accept no arguments for the use-case specified in the related ticket. (prisma docs: https://www.prisma.io/docs/orm/reference/prisma-schema-reference#dbgenerated)

However it does NOT supports empty strings but I don't think this can be expressed here.

Looking forward to any feedback.

clementoriol avatar May 01 '24 15:05 clementoriol

Walkthrough

Walkthrough

The recent update modifies the dbgenerated function within the stdlib.zmodel file to now accept an optional string parameter. This change enhances flexibility by allowing the function to be invoked without arguments, aligning with scenarios like the default value generation in database schemas.

Changes

File Path Change Summary
packages/schema/src/.../stdlib.zmodel Updated dbgenerated function to accept an optional expr parameter.

Possibly related issues

  • zenstackhq/zenstack#1400 - The issue reports that zmodel does not support calling dbgenerated() without parameters, which this PR addresses by making the expr parameter optional. This change should resolve the error mentioned in the issue.

Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between 96390fd296c973ca46f90e3d4293a7d3895823b1 and 3d9db976ee9f839914e30470fd0f4dd43a37ace2.
Files selected for processing (1)
  • packages/schema/src/res/stdlib.zmodel (1 hunks)
Additional comments not posted (1)
packages/schema/src/res/stdlib.zmodel (1)

115-115: The change to make the expr parameter optional in dbgenerated function is correctly implemented and aligns with the Prisma documentation.


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:

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 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.

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.
  • 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.

coderabbitai[bot] avatar May 01 '24 15:05 coderabbitai[bot]

Thank you for the fix @clementoriol ! Yes, Prisma's doc is a bit fuzzy about function details. I like that we can tweak to provide better flexibility. The change looks good to me and I'll merge it after CI passes. Will include it into a new patch release soon.

ymc9 avatar May 02 '24 11:05 ymc9