[BUG] Sort m2m fields before comparing them with diff(...)

[mykolasolodukha]

What?

• Sort new_m2m_fields before comparing them using dictdiffer.diff(...).

Why?

Otherwise, if one adds more m2m fields, the diff would produce the action="change" result, instead of the action="add" one. See:

• Wrong diff in case of removing a non last index of an array inveniosoftware/dictdiffer#100
• ignore_order inveniosoftware/dictdiffer#170

How to test?

Try migrating this:

# models.py
class User(tortoise.Model):

    id = fields.BigIntField(pk=True, generated=False)

    groups: fields.ManyToManyRelation[Group]

class Group(tortoise.Model):

    users: fields.ManyToManyRelation[User] = fields.ManyToManyField(
        "bot.User", through="group__user", related_name="groups"
    )

To this:

# models.py
class User(tortoise.Model):

    id = fields.BigIntField(pk=True, generated=False)

    groups: fields.ManyToManyRelation[Group]
    admin_in_groups: fields.ManyToManyRelation[Group]

class Group(tortoise.Model):

    users: fields.ManyToManyRelation[User] = fields.ManyToManyField(
        "bot.User", through="group__user", related_name="groups"
    )
    admins: fields.ManyToManyRelation[User] = fields.ManyToManyField(
        "bot.User", through="group__admin", related_name="admin_in_groups"
    )

aerich migrate --name "add_group_admins"

Anything else?

I think this kind of sorting might help with other types of fields as well, but I have no time to investigate that right now. The fix in this PR is urgent to me, though.

[LanceMoe]

I have the same problem, aerich doesn't work at all. This PR solves the problem. Please merge this!

[waketzheng]

It is better to only sort new m2m fields when it has more than one elements:

if len(new_m2m_fields) > 1 and old_m2m_fields:
    length = len(old_m2m_fields)
    field_index = {f['name']: i for i, f in enumerate(new_m2m_fields)}
    new_m2m_fields.sort(key=lambda field: field_index.get(field['name'], length))

[waketzheng]

This PR will fixes #150