fix(zmodel): allow @db.Json and @db.JsonB attributes on typed-json fields

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes expand the applicability of the @db.Json() and @db.JsonB() attributes in the schema definition to allow their use on both JsonField and TypeDefField. Additionally, a new integration test is introduced to verify these attributes' usage in Prisma models for PostgreSQL.

Changes

File(s)	Change Summary
packages/schema/src/res/stdlib.zmodel	Expanded attribute targets for @db.Json() and @db.JsonB() to include both JsonField and TypeDefField.
tests/integration/tests/enhancements/json/typing.test.ts	Added a new test case to verify explicit use of @db.Json and @db.JsonB on JSON fields for PostgreSQL.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant SchemaLoader
    participant SchemaDefinition

    TestRunner->>SchemaLoader: loadSchema(schema, provider: 'postgresql')
    SchemaLoader->>SchemaDefinition: Parse schema with @db.Json/@db.JsonB on JsonField and TypeDefField
    SchemaDefinition-->>SchemaLoader: Accepts attributes on both field types
    SchemaLoader-->>TestRunner: Schema loaded without errors

Loading

Possibly related PRs

• Enable JSON fields for SQLite #2081: Modifies provider support for typedef fields, directly relating to the expanded applicability of JSON attributes to TypeDefField in the schema.

---

📜 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 15b13f5 and 33479a8.

📒 Files selected for processing (2)

• packages/schema/src/res/stdlib.zmodel (1 hunks)
• tests/integration/tests/enhancements/json/typing.test.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

tests/integration/tests/enhancements/json/typing.test.ts (1)

packages/testtools/src/schema.ts (1)

• loadSchema (173-379)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

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

🔇 Additional comments (2)

packages/schema/src/res/stdlib.zmodel (1)

508-509: LGTM! Expansion of JSON attribute applicability is correct.

The changes appropriately expand the target field applicability of @db.Json() and @db.JsonB() attributes to include both JsonField and TypeDefField. This enables these database-specific JSON attributes to be used on typed JSON fields (TypeDefField with @json attribute), which aligns perfectly with the PR objective.

tests/integration/tests/enhancements/json/typing.test.ts (1)

389-420: LGTM! Test effectively validates the new functionality.

The test appropriately verifies that @db.Json and @db.JsonB attributes can now be used on typed JSON fields:

• Uses Profile type with @json @db.Json on the profile field
• Uses Meta type with @json @db.JsonB on the meta field
• Correctly uses PostgreSQL provider (appropriate for JsonB testing)
• Focuses on schema loading validation, which is sufficient for testing attribute applicability

This test effectively demonstrates that the expanded attribute applicability works as intended.

✨ 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

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