fix: support custom types in db pusher

[ymc9]

No description provided.

[claude]

Claude finished @ymc9's task —— View job

---

Code Review Complete ✅

Reviewing PR: fix: support custom types in db pusher

Review Checklist

• Read and understand the changed files
• Analyze code quality and best practices
• Check for potential bugs or issues
• Evaluate performance considerations
• Review security concerns
• Assess test coverage needs
• Provide comprehensive feedback

---

📋 Change Summary

This PR adds support for custom types (typeDefs) in the database schema pusher. The changes are minimal and focused:

Key Changes:

1. New method isCustomType() in SchemaDbPusher - checks if a field type exists in the schema's typeDefs
2. Custom type mapping - maps custom types to jsonb column type in mapFieldType()
3. TODO item added - tracks datasource provider-scoped attributes feature

---

✅ Code Quality Assessment

Positive Aspects:

1. 🎯 Minimal and focused change - The fix is surgical and doesn't introduce unnecessary complexity
2. ♻️ Consistent with existing patterns - Uses the same enum/built-in type checking pattern already established
3. 📍 Correct placement - The custom type check is positioned before the built-in type matching, which is the right order
4. 🗃️ Appropriate storage choice - Using jsonb for custom types aligns with PostgreSQL best practices for structured data
5. 🛡️ Safe fallback - The null-safe optional chaining (schema.typeDefs && ...) prevents runtime errors

Code Structure:

// Clean, readable implementation
private isCustomType(type: string) {
    return this.schema.typeDefs && Object.values(this.schema.typeDefs).some((def) => def.name === type);
}

// Proper integration in mapFieldType()
if (this.isCustomType(fieldDef.type)) {
    return 'jsonb';
}

---

⚠️ Areas for Consideration

1. Database Provider Limitation

Issue: The code always returns 'jsonb' for custom types, but jsonb is PostgreSQL-specific.

Impact: SQLite doesn't have a native jsonb type. While it might work (SQLite is flexible), it could cause issues.

Recommendation:

if (this.isCustomType(fieldDef.type)) {
    return this.schema.provider.type === 'postgresql' ? 'jsonb' : 'text';
}

2. Performance Consideration

Issue: Object.values(this.schema.typeDefs).some() scans all typeDefs for every field check.

Impact: Minor performance impact, but could be optimized for schemas with many custom types.

Suggestion: Consider caching custom type names in a Set during construction for O(1) lookups.

3. Missing Test Coverage

Observation: No tests specifically cover the custom type db push functionality.

Recommendation: Add a test case to packages/cli/test/db.test.ts:

it('should handle custom types in db push', () => {
    const modelWithCustomType = `
        type Address {
            street String
            city String
        }
        
        model User {
            id String @id @default(cuid())
            address Address
        }
    `;
    const workDir = createProject(modelWithCustomType);
    runCli('db push', workDir);
    expect(fs.existsSync(path.join(workDir, 'zenstack/dev.db'))).toBe(true);
});

---

🔒 Security & Safety

✅ No security concerns identified

• Pure type mapping logic with no external inputs
• No SQL injection risks (uses Kysely's type system)
• Proper null/undefined safety

---

🚀 Performance Impact

✅ Minimal performance impact

• Small O(n) scan of typeDefs only for non-built-in types
• Early returns for common cases (enums, auto-increment, built-in types)
• Could be optimized but not critical for typical schemas

---

📝 Overall Assessment

Score: ⭐⭐⭐⭐☆ (4/5)

This is a solid, well-implemented fix that addresses the core issue cleanly. The code follows established patterns and integrates well with the existing architecture.

Minor Improvements Suggested:

1. Add database provider check for SQLite compatibility
2. Consider test coverage for custom type scenarios
3. Optional: Performance optimization for large typeDef schemas

Ready to Merge: ✅ Yes, with optional improvements above

The changes are backwards compatible and won't break existing functionality. The fix correctly handles the case where custom types need to be stored in the database schema.

---

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/db-push-custom-type

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[Copilot]

Pull Request Overview

This pull request fixes support for custom types in the database pusher by ensuring they are properly mapped to PostgreSQL JSONB columns. The change prevents errors when custom types are encountered during database schema generation.

• Adds detection for custom types in field definitions
• Maps custom types to JSONB column type in PostgreSQL
• Updates TODO list with new datasource provider-scoped attributes task

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
packages/runtime/src/client/helpers/schema-db-pusher.ts	Adds custom type detection and JSONB mapping logic
TODO.md	Adds new TODO item for datasource provider-scoped attributes

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}