Initialize nil migration opts earlier
#1117
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
brandur
force-pushed
the
brandur-zero-opts-early
branch
from
1b99a6e to
2cb7e3d
Compare
brandur
commented
Dec 30, 2025
rivermigrate/river_migrate.go
Outdated
| func (m *Migrator[TTx]) MigrateTx(ctx context.Context, tx TTx, direction Direction, opts *MigrateOpts) (*MigrateResult, error) { | ||
| if opts == nil { | ||
| opts = &MigrateOpts{} | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Alternatively these could be right at the beginning of migrateUp and migrateDown, but I figure the earlier the better and other places in the code we have that do this tend to come right away.
bgentry
approved these changes
Dec 30, 2025
Contributor
bgentry
left a comment
bgentry
left a comment
There was a problem hiding this comment.
I think I slightly prefer the alternative of putting these guards at the start of migrateUp / migrateDown since the caller is so thin, but either way is ok. Good fix!
The migration functions are supposed to allow you to call them with nil options, but I noticed in some cases it's not working properly for `MigrateTx` and it's possible to raise a nil pointer panic. Here, initialize a nil `opts` earlier to prevent the problem. This makes the code more obvious/conventional anyway in that it's easier to see that nil options is supposed to be supported.
brandur
force-pushed
the
brandur-zero-opts-early
branch
from
2cb7e3d to
71e1fab
Compare
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.
The migration functions are supposed to allow you to call them with
nil options, but I noticed in some cases it's not working properly for
MigrateTxand it's possible to raise a nil pointer panic.Here, initialize a nil
optsearlier to prevent the problem. This makesthe code more obvious/conventional anyway in that it's easier to see
that nil options is supposed to be supported.