Improve error messages when pgroll init has not been run
#745
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4875f20 to
9ee630f
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves the error messaging for commands that require pgroll initialization by verifying whether pgroll is initialized before performing operations.
- Introduces a new error variable (errPGRollNotInitialized) with a clear error message in cmd/errors.go.
- Adds initialization checks using IsInitialized in multiple CLI command implementations.
- Implements a new test in pkg/state/state_test.go to verify the behavior of IsInitialized.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| cmd/errors.go | Adds a new error variable with a clear error message. |
| pkg/state/state.go | Introduces/duplicates the IsInitialized method for checking. |
| pkg/state/state_test.go | Adds test to verify initialization behavior. |
| cmd/status.go | Adds initialization check before showing status. |
| cmd/start.go | Adds initialization check before starting migrations. |
| cmd/complete.go | Adds initialization check before completing migrations. |
| cmd/rollback.go | Adds initialization check before rolling back migrations. |
| cmd/migrate.go | Adds initialization check before migrating. |
| cmd/analyze.go | Adds initialization check before analyzing schema. |
| cmd/pull.go | Adds initialization check before pulling schema history. |
| cmd/latest.go | Adds initialization check before fetching the latest migration. |
Return true iff `pgroll` has been initialized in the database.
Ensure that the `State.IsInitialized` method returns `true` after the state has been initialized and `false` before it has been initialized.
9ee630f to
fc09a60
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves the CLI error messages for commands that require a prior initialization via pgroll init. The changes add a new error variable for uninitialized state, enhance multiple command flows to check initialization before proceeding, and include a test to verify the behavior of the initialization check.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| cmd/errors.go | Introduces a new error variable for uninitialized state with an error message. |
| pkg/state/state_test.go | Adds a test validating that IsInitialized returns the expected values before and after Init. |
| pkg/state/state.go | Adds the IsInitialized method to check whether the state has been initialized. |
| cmd/complete.go | Implements an initialization check before completing a migration. |
| cmd/start.go | Implements an initialization check before starting a migration. |
| cmd/status.go | Implements an initialization check before returning the status. |
| cmd/rollback.go | Implements an initialization check before rolling back a migration. |
| cmd/analyze.go | Implements an initialization check before analyzing the schema. |
| cmd/migrate.go | Implements an initialization check before running migrations. |
| cmd/pull.go | Implements an initialization check before pulling the migration history. |
| cmd/latest.go | Implements an initialization check before obtaining the latest version. |
kvch
approved these changes
Mar 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the error messages displayed by the CLI when attempting to run commands that require
pgroll initto have been run.Old example of
pgroll startbeforepgroll init:New error message:
The same change is applied to all other commands that need to run against an initialized database.
Closes #723