File Tree Diff: enabled by default (#12010)

* Requires readthedocs/ext-theme#564

Author: humitos

readthedocs/projects/migrations/0147_addons_filetreediff_enabled_by_default.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.2.19 on 2025-02-20 11:56
+
+from django.db import migrations, models
+from django_safemigrate import Safe
+
+
+def migrate(apps, schema_editor):
+    AddonsConfig = apps.get_model("projects", "AddonsConfig")
+    AddonsConfig.objects.filter(filetreediff_enabled__isnull=True).update(filetreediff_enabled=True)
+
+
+class Migration(migrations.Migration):
+
+    safe = Safe.after_deploy
+
+    dependencies = [
+        ('projects', '0146_addons_filetreediff_ignored_files'),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate),
+        migrations.AlterField(
+            model_name='addonsconfig',
+            name='filetreediff_enabled',
+            field=models.BooleanField(default=True),
+        ),
+        migrations.AlterField(
+            model_name='historicaladdonsconfig',
+            name='filetreediff_enabled',
+            field=models.BooleanField(default=True),
+        ),
+    ]

readthedocs/projects/models.py

@@ -193,7 +193,7 @@ class AddonsConfig(TimeStampedModel):
     ethicalads_enabled = models.BooleanField(default=True)
 
     # File Tree Diff
-    filetreediff_enabled = models.BooleanField(default=False, null=True, blank=True)
+    filetreediff_enabled = models.BooleanField(default=True)
     filetreediff_ignored_files = models.JSONField(
         help_text=_("List of ignored files. One per line."),
         null=True,

readthedocs/proxito/tests/responses/v1.json

@@ -155,7 +155,7 @@
       "inject_styles": true
     },
     "filetreediff": {
-      "enabled": false
+      "enabled": true
     },
     "flyout": {
       "enabled": true,

readthedocs/rtd_tests/tests/test_imported_file.py

@@ -25,6 +25,11 @@ class ImportedFileTests(TestCase):
 
     def setUp(self):
         self.project = get(Project)
+
+        # Disable File Tree Diff because these tests are not prepared
+        self.project.addons.filetreediff_enabled = False
+        self.project.addons.save()
+
         self.version = self.project.versions.get(slug=LATEST)
         self.build = get(
             Build,
@@ -351,31 +356,29 @@ def test_update_content(self):
     @mock.patch("readthedocs.projects.tasks.search.write_manifest")
     def test_create_file_tree_manifest(self, write_manifest):
         assert self.version.slug == LATEST
-        index_build(self.build.pk)
-        # File Tree Diff is not enabled by default
-        write_manifest.assert_not_called()
 
         self.project.addons.filetreediff_enabled = True
         self.project.addons.save()
+
         index_build(self.build.pk)
         manifest = FileTreeDiffManifest(
             build_id=self.build.pk,
             files=[
                 FileTreeDiffFile(
                     path="index.html",
-                    main_content_hash="f3336aabed1ae8057ffb0cca20d23d4c",
+                    main_content_hash=mock.ANY,
                 ),
                 FileTreeDiffFile(
                     path="404.html",
-                    main_content_hash="b855c3d54f84e075b70faa9958123377",
+                    main_content_hash=mock.ANY,
                 ),
                 FileTreeDiffFile(
                     path="test.html",
-                    main_content_hash="04e5dc4003413e36b8bec86bc5e28b07",
+                    main_content_hash=mock.ANY,
                 ),
                 FileTreeDiffFile(
                     path="api/index.html",
-                    main_content_hash="15958dc725d925c8524b1766cde73d66",
+                    main_content_hash=mock.ANY,
                 ),
             ],
         )