feat(cli): add mysql support to proxy

[ymc9]

Summary by CodeRabbit

Release Notes

• New Features
  • Added MySQL database support to the CLI, enabling configuration and connection management for MySQL databases.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[claude]

Claude finished @ymc9's task —— View job

---

Code Review: MySQL Support for CLI Proxy

Reviewing the pull request that adds MySQL support to the proxy functionality.

Review Tasks:

• Analyze package.json changes and dependency management
• Review proxy.ts implementation changes
• Check code quality and best practices
• Identify potential bugs or issues
• Evaluate performance considerations
• Assess security concerns
• Review test coverage needs
• Provide comprehensive feedback

✅ Overall Assessment: Good Implementation

This PR successfully adds MySQL support to the CLI proxy with a clean, consistent approach that follows the existing patterns for SQLite and PostgreSQL support.

Code Quality & Best Practices

✅ Excellent consistency - The MySQL implementation follows the exact same pattern as existing database providers
✅ Clean import organization - Imports are properly reorganized alphabetically
✅ Proper error handling - Uses the same error patterns as other database providers
✅ Consistent logging - Maintains the same logging format: "Connecting to MySQL database at: ${databaseUrl}"

Dependencies & Type Safety

✅ Proper dependency management - mysql2 is correctly added to package.json using catalog versioning (mysql2: "catalog:")
✅ Version consistency - Uses catalog version ^3.16.1 which is properly defined in the workspace catalog
✅ Type safety - mysql2 package includes its own TypeScript definitions, so no separate @types/mysql2 package is needed

Implementation Details

The changes are minimal and focused:

packages/cli/src/actions/proxy.ts:135-139

case 'mysql':
    console.log(colors.gray(`Connecting to MySQL database at: ${databaseUrl}`));
    return new MysqlDialect({
        pool: createMysqlPool(databaseUrl),
    });

✅ Correct usage - Uses createPool as createMysqlPool import to avoid naming conflicts with PostgreSQL's Pool
✅ Proper dialect integration - Leverages Kysely's MysqlDialect which is re-exported from @zenstackhq/orm/dialects/mysql

Potential Issues & Recommendations

🟡 Missing Type Definitions (Minor)

While mysql2 includes types, consider adding @types/mysql2 to devDependencies for better IDE support and version pinning:

"@types/mysql2": "catalog:"

🟡 Test Coverage (Important)

No tests exist for the proxy functionality. Consider adding:

• Unit tests for createDialect() function with MySQL provider
• Integration tests to verify MySQL connection handling
• Error handling tests for invalid MySQL connection strings

🟨 Connection Pool Configuration (Performance)

The current implementation uses mysql2's default pool settings. For production usage, consider exposing pool configuration options:

// Future enhancement suggestion
return new MysqlDialect({
    pool: createMysqlPool({
        uri: databaseUrl,
        max: 10, // configurable
        idleTimeoutMillis: 30000, // configurable
    }),
});

Security Considerations

✅ No security issues identified - The implementation safely delegates connection handling to the mysql2 library
✅ URL evaluation security - Uses the existing secure URL evaluation logic that properly handles environment variables

Performance Considerations

✅ Efficient connection pooling - Uses mysql2's built-in connection pooling
✅ Consistent with other providers - No performance regression compared to PostgreSQL/SQLite implementations

Summary

This is a well-implemented feature that adds MySQL support with minimal, clean changes. The implementation is consistent with existing patterns and properly integrates with the ZenStack architecture.

Recommendations for follow-up:

1. Add test coverage for MySQL proxy functionality
2. Consider adding MySQL-specific configuration options for connection pooling
3. Update documentation to reflect MySQL support in the proxy command

---

[coderabbitai]

📝 Walkthrough

Walkthrough

Two files modified to add MySQL support. mysql2 dependency added to package.json. proxy.ts enhanced with MysqlDialect and createMysqlPool function, PostgreSQL pool construction updated to use PgPool, SQLite support unchanged, no exported function signatures altered.

Changes

Cohort / File(s)	Summary
MySQL Support Implementation packages/cli/package.json, packages/cli/src/actions/proxy.ts	Added mysql2 dependency; introduced MysqlDialect and createMysqlPool to proxy.ts; updated dialect factory with new 'mysql' case; refactored PostgreSQL case to use PgPool; reordered imports for MySQL-related utilities; SQLite support preserved.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

Hop hop, MySQL hops in! 🐰
With pools and dialects to spin,
PgPool's here, Sqlite stays,
Through proxy's MySQL pathways,
New connections, fresh and keen,
Our database dreams convene! 🐇

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat(cli): add mysql support to proxy' directly and accurately summarizes the main change—adding MySQL support to the proxy functionality in the CLI package.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR adds MySQL database support to the CLI proxy functionality, enabling users to run a proxy server with MySQL as the backend database alongside the existing SQLite and PostgreSQL support.

Changes:

• Added mysql2 package dependency (version 3.16.1) to support MySQL connections
• Implemented MySQL dialect handling in the proxy action's createDialect function
• Alphabetically reorganized imports for better code organization

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File	Description
pnpm-lock.yaml	Adds mysql2@3.16.1 dependency to the lockfile
packages/cli/package.json	Adds mysql2 as a catalog dependency to the CLI package
packages/cli/src/actions/proxy.ts	Adds MySQL support to the proxy action by implementing the mysql case in createDialect function and importing necessary dependencies

Files not reviewed (1)

• pnpm-lock.yaml: Language not supported

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@packages/cli/src/actions/proxy.ts`:
- Line 136: The log currently prints the raw databaseUrl which may include
credentials; update the logging to redact credentials by parsing databaseUrl
(e.g., with the URL constructor or a regex) and removing username/password
components before logging (construct sanitizedUrl without auth info and use that
in the console.log call that references databaseUrl). Apply the same
sanitization to any PostgreSQL logging paths so both MySQL and Postgres logs
never output credentials; locate the console.log that prints databaseUrl and
replace it to log sanitizedUrl instead.
- Line 15: The console logs in packages/cli/src/actions/proxy.ts are printing
raw databaseUrl (e.g., mysql://user:password@host:port), exposing credentials;
modify the logging to use a sanitized URL instead: implement or call a helper
(e.g., sanitizeDatabaseUrl) that parses the databaseUrl (via URL or
connection-string parsing) and strips or replaces username and password with
redaction (e.g., user:*** or remove userinfo) and then use that sanitized value
in the existing log statements around the proxy startup (the spots referring to
databaseUrl at the logging lines), and apply the same sanitization for
PostgreSQL URLs as well so no credentials are printed.

[Copilot]

@ymc9 I've opened a new pull request, #626, to work on those changes. Once the pull request is ready, I'll request review from you.