[management] add flag to disable auto-migration #3840
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a skipMigration flag to disable automatic database migrations when initializing stores.
- Extended
NewStoreand all SQL store constructors to acceptskipMigrationand propagate it. - Wrapped existing migration steps in a conditional to skip or log migrations based on the new flag.
- Updated callers (including the main command and test helpers) to pass a default
falseortruefor testing/migration contexts.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| management/server/store/store.go | Added skipMigration parameter to NewStore and propagated it. |
| management/server/store/sql_store.go | Updated SQL store constructors & guarded migration logic. |
| management/cmd/management.go | Passed default false for skipMigration when creating the store. |
Comments suppressed due to low confidence (3)
management/server/store/store.go:245
- [nitpick] Update this doc comment to include the new
skipMigrationparameter and describe how it affects auto-migration behavior.
// NewStore creates a new store based on the provided engine type, data directory, and telemetry metrics
management/server/store/sql_store.go:91
- There are no tests verifying that migrations are correctly skipped or applied when
skipMigrationis toggled. Consider adding unit tests around both branches of this conditional.
if !skipMigration {
management/server/store/sql_store.go:1022
- [nitpick] The doc comment for
NewSqliteStoreshould be updated to mention theskipMigrationparameter and explain its effect on automatic migrations.
// NewSqliteStore creates a new SQLite store.
Comment on lines
68
to
+69
| // NewSqlStore creates a new SqlStore instance. | ||
| func NewSqlStore(ctx context.Context, db *gorm.DB, storeEngine types.Engine, metrics telemetry.AppMetrics) (*SqlStore, error) { | ||
| func NewSqlStore(ctx context.Context, db *gorm.DB, storeEngine types.Engine, metrics telemetry.AppMetrics, skipMigration bool) (*SqlStore, error) { |
There was a problem hiding this comment.
[nitpick] Consider replacing the boolean skipMigration flag with a functional options pattern or named configuration struct to improve readability at call sites (e.g., NewSqlStore(..., false) can be unclear).
Copilot uses AI. Check for mistakes.
mlsmaycon
reviewed
May 19, 2025
|
pnmcosta
approved these changes
May 19, 2025
mlsmaycon
approved these changes
May 19, 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.
Describe your changes
Issue ticket number and link
Stack
Checklist