feat: support for scalar list types

[ymc9]

Summary by CodeRabbit

• New Features
  • Added comprehensive support for array (scalar list) fields, enabling advanced filtering, creation, and update operations such as setting, pushing, and querying for array contents.
• Bug Fixes
  • Scalar list fields now default to empty arrays instead of null values when not set.
• Tests
  • Introduced new test suite covering creation, update, and filtering of scalar list fields.
• Style
  • Improved validation and error handling for array field operations in forms and API requests.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces comprehensive support for array-typed (scalar list) fields in the ORM client. It modifies type definitions, validation schemas, filter and update logic, SQL dialect handling, and result post-processing to enable creation, updating, and filtering of array fields. New tests are added to verify scalar list functionality.

Changes

File(s)	Change Summary
TODO.md	Marked "Array update" in ORM Update checklist as complete.
.../crud-types.ts	Added explicit array field support in type definitions for filtering, creation, and updates; introduced ArrayFilter and related types.
.../crud/dialects/base.ts	Added array filter logic to filter builder; refactored primitive filter methods to use model alias.
.../crud/dialects/postgresql.ts, .../crud/dialects/sqlite.ts	Enhanced primitive transformation to support arrays; PostgreSQL now handles empty arrays and array literals.
.../crud/operations/base.ts	Enhanced create/update logic for scalar list fields; added method for scalar list update operations.
.../crud/validator.ts	Added array filter schema and array update/create validation; refined numeric and array update constraints.
.../helpers/schema-db-pusher.ts	Changed NOT NULL logic to exclude array fields from being marked as NOT NULL.
.../query-utils.ts	Updated field reference builder to support model aliasing.
.../result-processor.ts	Ensured scalar list fields default to empty arrays instead of null in results.
.../test/client-api/scalar-list.test.ts	Added new test suite covering create, update, and filter operations for scalar list fields.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Validator
    participant Handler
    participant Dialect
    participant DB

    Client->>Validator: Validate create/update/filter payload (array field)
    Validator-->>Client: Return validated payload
    Client->>Handler: Call create/update/filter with payload
    Handler->>Dialect: Transform array payload (set/push/filter ops)
    Dialect->>DB: Generate SQL for array operations (set, push, filter)
    DB-->>Dialect: Return result
    Dialect-->>Handler: Process result (arrays as empty if null)
    Handler-->>Client: Return processed result

Loading

Possibly related PRs

• zenstackhq/zenstack-v3#9: Adds and enhances support for array-typed fields in the runtime client, including filter, create, and update operations, and dialect-specific handling for PostgreSQL arrays.

Poem

In fields where arrays now dance and play,
The client can filter, set, or push away.
From empty to full, each list finds its tune,
With tests to ensure they won’t break soon.
Hooray for the lists—this hop’s for you!
🐇✨

---

📜 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 70f0662 and d2a4732.

📒 Files selected for processing (11)

• TODO.md (1 hunks)
• packages/runtime/src/client/crud-types.ts (6 hunks)
• packages/runtime/src/client/crud/dialects/base.ts (2 hunks)
• packages/runtime/src/client/crud/dialects/postgresql.ts (2 hunks)
• packages/runtime/src/client/crud/dialects/sqlite.ts (1 hunks)
• packages/runtime/src/client/crud/operations/base.ts (5 hunks)
• packages/runtime/src/client/crud/validator.ts (4 hunks)
• packages/runtime/src/client/helpers/schema-db-pusher.ts (1 hunks)
• packages/runtime/src/client/query-utils.ts (1 hunks)
• packages/runtime/src/client/result-processor.ts (2 hunks)
• packages/runtime/test/client-api/scalar-list.test.ts (1 hunks)

✨ 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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• 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.