Opened 20 months ago

Last modified 20 months ago

#34304 closed Bug

Adding and removing a conditional UniqueConstraint to ForeignKey multiple times crashes on MySQL — at Initial Version

Reported by: Sage Abdullah Owned by: Sage Abdullah
Component: Database layer (models, ORM) Version: 4.2
Severity: Release blocker Keywords: GeyseR
Cc: mysql Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Adding and removing a UniqueConstraint to ForeignKey with a condition more than once on MySQL will crash the schema editor an OperationalError, e.g. django.db.utils.OperationalError: (1061, "Duplicate key name 'schema_book_author_id_c80c8297'")

Test in tests.schema.tests:


    def test_unique_with_fk_and_condition_multiple_times(self):
        """
        Tests adding and removing a unique constraint to ForeignKey
        with a condition multiple times.
        """
        with connection.schema_editor() as editor:
            editor.create_model(Author)
            editor.create_model(Book)
        constraint = UniqueConstraint(
            "author",
            condition=Q(title__in=["tHGttG", "tRatEotU"]),
            name="book_author_condition_uniq",
        )

        for i in range(2):
            # Add constraint.
            with connection.schema_editor() as editor:
                editor.add_constraint(Book, constraint)
                sql = constraint.create_sql(Book, editor)
            book_table = Book._meta.db_table
            constraints = self.get_constraints(book_table)
            if connection.features.supports_partial_indexes:
                self.assertIn(constraint.name, constraints)
                self.assertIs(constraints[constraint.name]["unique"], True)
                self.assertIn("WHERE %s IN" % editor.quote_name("title"), str(sql))
            else:
                self.assertNotIn(constraint.name, constraints)
                self.assertIsNone(sql)
            # Remove constraint.
            with connection.schema_editor() as editor:
                editor.remove_constraint(Book, constraint)
            self.assertNotIn(constraint.name, self.get_constraints(book_table))

This is a regression in b731e8841558ee4caaba766c83f34ea9c7004f8b.

Use case:
Wagtail supports multiple database backends. We have a migration that adds a unique constraint to a foreign key with a condition. In addition, we also have migrations that alter the field referenced in the condition. Before making an alter field operation, we need to remove the unique constraint to avoid violating the constraint, then re-add the constraint after the field has been altered. We have more than one migrations that do these operations, thus triggering the error. This issue only happens on MySQL, specifically after the above commit was merged into Django.

Relevant migrations in Wagtail:

Change History (0)

Note: See TracTickets for help on using tickets.
Back to Top