Make add_foreign_key retriable when safe_by_default is enabled #273
Conversation
This file contains 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
chaadow
commented
Sep 1, 2024
| @migration.reversible do |dir| | ||
| dir.up do | ||
| @migration.add_foreign_key(from_table, to_table, *args, **options.merge(validate: false)) | ||
| # https://github.com/rails/rails/blob/main/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb#L1154C96-L1154C120 | ||
| # if_not_exists does not check again `name` option. |
There was a problem hiding this comment.
Until a fix is done/merged on Rails, I believe we still need to leave this.
This was detected by AddForeignKeyName test class, as it creates 2 foreign keys on the same column but with different names ( It's quite rare I think for users of this gem to encounter this case but nonetheless, it's more robust and makes tests pass )
When adding a foreign key and safe mode is enabled: - We create a NOT VALID foreign key - Then we commit the transaction - Finally we validate the foreign key constraint if the validation fails, this leaves a NOT VALID foreign key in the database. If we retry after having cleaned up the database, the creation of the NOT VALID foreign key constraint will fail because it will already be in the DB. This commit makes the migration safely retriable by checking if said foreign key constraint already exists, and if so, skips its creation again. When validation of foreign key fails, we also remove the NOT VALID foreign key constraint as to not leave the database in an unstable state.
chaadow
force-pushed
the
fix_safe_default_add_foreign_key
branch
from
e5f9621
to
f7e12e8
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.
related to #272 and #271
When adding a foreign key and safe mode is enabled:
if the validation fails, this leaves a NOT VALID foreign key in the database.
If we retry after having cleaned up the database, the creation of the NOT VALID foreign key constraint will fail because it will already be in the DB.
This commit makes the migration safely retriable by checking if said foreign key constraint already exists, and if so, skips its creation again.
When validation of foreign key fails, we also remove the NOT VALID foreign key constraint as to not leave the database in an unstable state.