feat: add "migrate resolve" command to CLI

[ymc9]

No description provided.

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

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 feat/cli-migrate-resolve

---

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.

[claude]

Claude finished @ymc9's task —— View job

---

Code Review Complete

Reviewing PR #171: feat: add "migrate resolve" command to CLI

Todo List:

• Read and analyze all changed files
• Review implementation logic and code quality
• Check for bugs and potential issues
• Evaluate security considerations
• Assess test coverage adequacy
• Provide comprehensive feedback

---

Review Feedback

🐛 Critical Bug Found

File: packages/cli/src/index.ts:108

.action((options) => migrateAction('status', options));

Issue: The resolve command incorrectly calls migrateAction('status', options) instead of migrateAction('resolve', options). This means the resolve command will execute the status command instead.

Fix:

.action((options) => migrateAction('resolve', options));

✅ Code Quality & Implementation

Strengths:

1. Well-structured command definition - Follows the existing pattern with proper option definitions
2. Good validation logic - The runResolve function correctly validates that at least one of --applied or --rolled-back is provided
3. Consistent error handling - Uses the same handleSubProcessError pattern as other migrate commands
4. Proper TypeScript typing - Defines ResolveOptions type correctly extending CommonOptions
5. Clean command construction - Builds the Prisma command string properly with conditional options

Implementation details:

• The function correctly passes through to Prisma's migrate resolve command
• Proper schema file handling with temporary file cleanup
• Option naming follows Prisma's conventions (--applied, --rolled-back)

🧪 Test Coverage Assessment

Strengths:

1. Functional test coverage - Tests both --applied and --rolled-back options
2. Integration approach - Tests the actual CLI command execution path
3. Realistic test scenario - Creates a real migration first, then tests resolving it

Areas for improvement:

1. Missing validation test - No test for the error case when neither --applied nor --rolled-back is provided
2. Edge case testing - Could benefit from testing invalid migration names or non-existent migrations

Suggested additional test:

it('should throw error when neither applied nor rolled-back is provided', () => {
    const workDir = createProject(model);
    expect(() => runCli('migrate resolve', workDir)).toThrow();
});

🔒 Security Considerations

Good practices:

1. No injection vulnerabilities - Migration names are properly passed to Prisma CLI
2. Input validation - Validates required options before execution
3. Error handling - Proper exit codes and error propagation

📈 Performance Considerations

Efficient approach:

1. Direct delegation - Efficiently delegates to Prisma's native migrate resolve command
2. Temporary file management - Proper cleanup of generated Prisma schema files
3. No unnecessary overhead - Minimal additional processing

📋 Minor Suggestions

1. Documentation: Consider adding more detailed description or examples for the resolve command
2. Type safety: The rolledBack property in ResolveOptions could be rollbacked to match the CLI option name, though current naming is fine
3. README update: The README.md change appears unrelated to this feature (package installation instruction update)

✅ Overall Assessment

This is a well-implemented feature that follows ZenStack's established patterns and properly integrates with Prisma's migration system. The critical bug in the action handler needs to be fixed, but otherwise the implementation is solid with good validation, error handling, and test coverage.

Recommendation: Approve after fixing the critical bug in index.ts:108.

---

[Copilot]

Pull Request Overview

This PR adds a new "migrate resolve" command to the CLI that allows users to resolve issues with database migrations in deployment databases. The command provides options to mark specific migrations as either applied or rolled back.

• Adds migrate resolve command with --applied and --rolled-back options
• Implements validation to ensure at least one option is provided
• Adds comprehensive test coverage for the new command

Reviewed Changes

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

File	Description
packages/cli/src/index.ts	Adds the new migrate resolve command definition with options
packages/cli/src/actions/migrate.ts	Implements the resolve functionality and validation logic
packages/cli/test/migrate.test.ts	Adds test coverage for the new resolve command
README.md	Updates package installation instructions (unrelated change)

---

_{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.}

[claude]

Claude finished @ymc9's task —— View job

---

Code Review Complete

Reviewing PR #171: feat: add "migrate resolve" command to CLI

Todo List:

• Read and analyze all changed files
• Review implementation logic and code quality
• Check for bugs and potential issues
• Evaluate security considerations
• Assess test coverage adequacy
• Provide comprehensive feedback

---

🐛 Critical Bug Found

File: packages/cli/src/index.ts:108

.action((options) => migrateAction('status', options));

Issue: The resolve command incorrectly calls migrateAction('status', options) instead of migrateAction('resolve', options). This means the resolve command will execute the status command instead.

Fix Required:

.action((options) => migrateAction('resolve', options));

✅ Code Quality & Implementation

Strengths:

1. Well-structured command definition - Follows existing CLI patterns with proper option definitions
2. Good validation logic - runResolve function correctly validates that at least one of --applied or --rolled-back is provided
3. Consistent error handling - Uses same handleSubProcessError pattern as other migrate commands
4. Proper TypeScript typing - ResolveOptions type correctly extends CommonOptions
5. Clean command construction - Builds Prisma command string properly with conditional options
6. Efficient delegation - Properly delegates to Prisma's native migrate resolve command

Implementation Details:

• Function correctly passes through to Prisma's migrate resolve command
• Proper schema file handling with temporary file cleanup
• Option naming follows Prisma's conventions (--applied, --rolled-back)

🧪 Test Coverage Assessment

Strengths:

1. Functional test coverage - Tests both --applied and --rolled-back options (packages/cli/test/migrate.test.ts:42-56)
2. Integration approach - Tests actual CLI command execution path
3. Realistic scenario - Creates migration first, then tests resolving it

Areas for Improvement:

1. Missing validation test - No test for error case when neither --applied nor --rolled-back is provided
2. Edge case testing - Could benefit from testing invalid migration names

Suggested Additional Test:

it('should throw error when neither applied nor rolled-back is provided', () => {
    const workDir = createProject(model);
    expect(() => runCli('migrate resolve', workDir)).toThrow();
});

🔒 Security Considerations

Good Practices:

1. No injection vulnerabilities - Migration names are properly passed to Prisma CLI
2. Input validation - Validates required options before execution
3. Error handling - Proper exit codes and error propagation

📈 Performance Considerations

Efficient Approach:

1. Direct delegation - Efficiently delegates to Prisma's native command
2. Temporary file management - Proper cleanup of generated Prisma schema files
3. No unnecessary overhead - Minimal additional processing

📋 Minor Suggestions

1. Documentation: Consider adding examples for the resolve command usage
2. Type naming: The rolledBack property in ResolveOptions could be rollbacked to match CLI option, though current naming is fine
3. README: The README.md change appears unrelated to this feature (package installation instruction update)

✅ Overall Assessment

This is a well-implemented feature that follows ZenStack's established patterns and properly integrates with Prisma's migration system. The critical bug in the action handler needs to be fixed, but otherwise the implementation is solid with good validation, error handling, and test coverage.

Recommendation: Approve after fixing the critical bug in index.ts:108.

---

[claude]

Claude finished @ymc9's task —— View job

---

Code Review Complete

Reviewing PR #171: feat: add "migrate resolve" command to CLI

Todo List:

• Read and analyze all changed files
• Review implementation logic and code quality
• Check for bugs and potential issues
• Evaluate security considerations
• Assess test coverage adequacy
• Provide comprehensive feedback

---

✅ Critical Bug Was Fixed

Previous Issue (Now Resolved): The initial implementation had a critical bug in packages/cli/src/index.ts:108 where the resolve command called migrateAction('status', options) instead of migrateAction('resolve', options). This has been fixed in commit eff9c80.

✅ Code Quality & Implementation

Strengths:

1. Well-structured command definition - Follows existing CLI patterns with proper option definitions
2. Good validation logic - runResolve function correctly validates that at least one of --applied or --rolled-back is provided (packages/cli/src/actions/migrate.ts:114-116)
3. Consistent error handling - Uses same handleSubProcessError pattern as other migrate commands
4. Proper TypeScript typing - ResolveOptions type correctly extends CommonOptions (packages/cli/src/actions/migrate.ts:25-28)
5. Clean command construction - Builds Prisma command string properly with conditional options (packages/cli/src/actions/migrate.ts:119-124)
6. Efficient delegation - Properly delegates to Prisma's native migrate resolve command

Implementation Details:

• Function correctly passes through to Prisma's migrate resolve command
• Proper schema file handling with temporary file cleanup (packages/cli/src/actions/migrate.ts:60-64)
• Option naming follows Prisma's conventions (--applied, --rolled-back)

🧪 Test Coverage Assessment

Strengths:

1. Functional test coverage - Tests both --applied and --rolled-back options (packages/cli/test/migrate.test.ts:42-56)
2. Integration approach - Tests actual CLI command execution path
3. Realistic scenario - Creates migration first, then tests resolving it
4. Error validation test - Includes test for error case when neither option is provided (packages/cli/test/migrate.test.ts:58-61)

Good Coverage: The test implementation covers the main use cases and error scenarios adequately.

🔒 Security Considerations

Good Practices:

1. No injection vulnerabilities - Migration names are properly passed to Prisma CLI
2. Input validation - Validates required options before execution
3. Error handling - Proper exit codes and error propagation

📈 Performance Considerations

Efficient Approach:

1. Direct delegation - Efficiently delegates to Prisma's native command
2. Temporary file management - Proper cleanup of generated Prisma schema files
3. No unnecessary overhead - Minimal additional processing

📋 Minor Observations

1. Unrelated change: The README.md change appears unrelated to this feature (package installation instruction update)
2. Code follows patterns: Implementation follows established ZenStack CLI patterns consistently
3. Documentation: Command description is clear and helpful

✅ Overall Assessment

This is a well-implemented feature that:

• ✅ Follows ZenStack's established patterns
• ✅ Properly integrates with Prisma's migration system
• ✅ Has good validation and error handling
• ✅ Includes comprehensive test coverage
• ✅ The critical bug has been fixed

Recommendation: ✅ Approve - The implementation is solid and ready for merge.

---

[claude]

Claude finished @ymc9's task —— View job

---

Code Review Complete

Reviewing PR #171: feat: add "migrate resolve" command to CLI

Todo List:

• Read and analyze all changed files
• Review implementation logic and code quality
• Check for bugs and potential issues
• Evaluate security considerations
• Assess test coverage adequacy
• Provide comprehensive feedback

---

Review Feedback

✅ Code Quality & Implementation

Strengths:

1. Well-structured command definition - Follows existing CLI patterns with proper option definitions
2. Good validation logic - runResolve function correctly validates that at least one of --applied or --rolled-back is provided (packages/cli/src/actions/migrate.ts:114-116)
3. Consistent error handling - Uses same handleSubProcessError pattern as other migrate commands
4. Proper TypeScript typing - ResolveOptions type correctly extends CommonOptions (packages/cli/src/actions/migrate.ts:25-28)
5. Clean command construction - Builds Prisma command string properly with conditional options (packages/cli/src/actions/migrate.ts:119-124)
6. Efficient delegation - Properly delegates to Prisma's native migrate resolve command

Implementation Details:

• Function correctly passes through to Prisma's migrate resolve command
• Proper schema file handling with temporary file cleanup (packages/cli/src/actions/migrate.ts:60-64)
• Option naming follows Prisma's conventions (--applied, --rolled-back)

🧪 Test Coverage Assessment

Strengths:

1. Functional test coverage - Tests both --applied and --rolled-back options (packages/cli/test/migrate.test.ts:42-66)
2. Integration approach - Tests actual CLI command execution path
3. Realistic scenario - Creates migration first, then tests resolving it
4. Error validation test - Includes test for error case when neither option is provided (packages/cli/test/migrate.test.ts:68-71)

Good Coverage: The test implementation covers the main use cases and error scenarios adequately.

🔒 Security Considerations

Good Practices:

1. No injection vulnerabilities - Migration names are properly passed to Prisma CLI
2. Input validation - Validates required options before execution
3. Error handling - Proper exit codes and error propagation

📈 Performance Considerations

Efficient Approach:

1. Direct delegation - Efficiently delegates to Prisma's native command
2. Temporary file management - Proper cleanup of generated Prisma schema files
3. No unnecessary overhead - Minimal additional processing

📋 Minor Observations

1. Unrelated change: The README.md change appears unrelated to this feature (package installation instruction update)
2. Code follows patterns: Implementation follows established ZenStack CLI patterns consistently
3. Documentation: Command description is clear and helpful

✅ Overall Assessment

This is a well-implemented feature that:

• ✅ Follows ZenStack's established patterns
• ✅ Properly integrates with Prisma's migration system
• ✅ Has good validation and error handling
• ✅ Includes comprehensive test coverage
• ✅ No critical bugs found

Recommendation: ✅ Approve - The implementation is solid and ready for merge.

---