Fix create/drop indexes in every migration (#377)

* Add `__eq__` method for `Index`instances

* tests: add Index test case

* refactor: compare index instances before set hash and eq func to class

* fix: sort fields when generating index hash

* docs: update changlog

* fix style issue

* refactor: use CustomIndex instead of postgres special HashIndex

* Check tortoise version before patch Index

* Add comment

* Add comment for why > work

---------

Co-authored-by: dbf <somnium@riseup.net>

tests/indexes.py

@@ -0,0 +1,7 @@
+from tortoise.indexes import Index
+
+
+class CustomIndex(Index):
+    def __init__(self, *args, **kw) -> None:
+        super().__init__(*args, **kw)
+        self._foo = ""

tests/models.py

@@ -3,6 +3,9 @@ import uuid
 from enum import IntEnum
 
 from tortoise import Model, fields
+from tortoise.indexes import Index
+
+from tests.indexes import CustomIndex
 
 
 class ProductType(IntEnum):
@@ -33,6 +36,10 @@ class User(Model):
 
     products: fields.ManyToManyRelation["Product"]
 
+    class Meta:
+        # reverse indexes elements
+        indexes = [CustomIndex(fields=("is_superuser",)), Index(fields=("username", "is_active"))]
+
 
 class Email(Model):
     email_id = fields.IntField(primary_key=True)

tests/old_models.py

@@ -2,6 +2,9 @@ import datetime
 from enum import IntEnum
 
 from tortoise import Model, fields
+from tortoise.indexes import Index
+
+from tests.indexes import CustomIndex
 
 
 class ProductType(IntEnum):
@@ -31,6 +34,9 @@ class User(Model):
     intro = fields.TextField(default="")
     longitude = fields.DecimalField(max_digits=12, decimal_places=9)
 
+    class Meta:
+        indexes = [Index(fields=("username", "is_active")), CustomIndex(fields=("is_superuser",))]
+
 
 class Email(Model):
     email = fields.CharField(max_length=200)

tests/test_migrate.py

@@ -3,6 +3,7 @@ from pathlib import Path
 import pytest
 import tortoise
 from pytest_mock import MockerFixture
+from tortoise.indexes import Index
 
 from aerich.ddl.mysql import MysqlDDL
 from aerich.ddl.postgres import PostgresDDL
@@ -10,6 +11,7 @@ from aerich.ddl.sqlite import SqliteDDL
 from aerich.exceptions import NotSupportError
 from aerich.migrate import MIGRATE_TEMPLATE, Migrate
 from aerich.utils import get_models_describe
+from tests.indexes import CustomIndex
 
 # tortoise-orm>=0.21 changes IntField constraints
 # from {"ge": 1, "le": 2147483647} to {"ge": -2147483648, "le": 2147483647}
@@ -608,7 +610,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
-        "indexes": [],
+        "indexes": [Index(fields=("username", "is_active")), CustomIndex(fields=("is_superuser",))],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",