Search: migrate null ranks to zero

Author: stsewd

readthedocs/projects/migrations/0058_migrate_null_rank.py

@@ -0,0 +1,20 @@
+# Generated by Django 2.2.12 on 2020-07-07 23:31
+
+from django.db import migrations
+
+
+def forwards_func(apps, schema_editor):
+    """Sets all null ranks to zero."""
+    ImportedFile = apps.get_model('projects', 'ImportedFile')
+    ImportedFile.objects.filter(rank=None).update(rank=0)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0057_add_page_rank'),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_func),
+    ]

readthedocs/projects/migrations/0059_make_rank_not_null.py

@@ -0,0 +1,19 @@
+# Generated by Django 2.2.12 on 2020-07-07 23:35
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0058_migrate_null_rank'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='importedfile',
+            name='rank',
+            field=models.IntegerField(default=0, validators=[django.core.validators.MinValueValidator(-10), django.core.validators.MaxValueValidator(10)], verbose_name='Page search rank'),
+        ),
+    ]

readthedocs/projects/models.py

@@ -1355,9 +1355,7 @@ class ImportedFile(models.Model):
     modified_date = models.DateTimeField(_('Modified date'), auto_now=True)
     rank = models.IntegerField(
         _('Page search rank'),
-        # default=0,
-        # TODO: remove after migration
-        null=True,
+        default=0,
         validators=[MinValueValidator(-10), MaxValueValidator(10)],
     )
 

readthedocs/search/documents.py

@@ -94,8 +94,7 @@ class Meta:
         ignore_signals = True
 
     def prepare_rank(self, html_file):
-        # TODO: remove when the migration is done
-        if html_file.rank is None or not (-10 <= html_file.rank <= 10):
+        if not (-10 <= html_file.rank <= 10):
             return 0
         return html_file.rank
 

readthedocs/search/tests/test_api.py

@@ -516,8 +516,8 @@ def test_search_custom_ranking(self, api_client):
         page_guides = HTMLFile.objects.get(path='guides/index.html')
 
         # Query with the default ranking
-        assert page_index.rank is None
-        assert page_guides.rank is None
+        assert page_index.rank == 0
+        assert page_guides.rank == 0
 
         search_params = {
             'project': project.slug,