Run FileTreeDiff indexer on all versions in dev (#11873)

This allows easier support for working on this locally, and runs it against all active verisons. --------- Co-authored-by: Manuel Kaufmann <[email protected]>
readthedocs · Jan 21, 2025 · 836cf22 · 836cf22
1 parent 795e6a1
commit 836cf22
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/docs/dev/settings.rst b/docs/dev/settings.rst
@@ -63,6 +63,11 @@ Use this storage class to upload build artifacts to cloud storage (S3, Azure sto
 This should be a dotted path to the relevant class (eg. ``'path.to.MyBuildMediaStorage'``).
 Your class should mixin :class:`readthedocs.builds.storage.BuildMediaStorageMixin`.
 
+RTD_FILETREEDIFF_ALL
+--------------------
+
+Set to ``True`` to enable the file tree diff feature for all projects.
+
 
 ELASTICSEARCH_DSL
 -----------------

diff --git a/readthedocs/projects/tasks/search.py b/readthedocs/projects/tasks/search.py
@@ -1,6 +1,7 @@
 from fnmatch import fnmatch
 
 import structlog
+from django.conf import settings
 
 from readthedocs.builds.constants import BUILD_STATE_FINISHED, INTERNAL, LATEST
 from readthedocs.builds.models import Build, Version
@@ -172,7 +173,9 @@ def _get_indexers(*, version: Version, build: Build, search_index_name=None):
         else LATEST
     )
     create_manifest = version.project.addons.filetreediff_enabled and (
-        version.is_external or version.slug == base_version
+        version.is_external
+        or version.slug == base_version
+        or settings.RTD_FILETREEDIFF_ALL
     )
     if create_manifest:
         file_manifest_indexer = FileManifestIndexer(

diff --git a/readthedocs/proxito/views/hosting.py b/readthedocs/proxito/views/hosting.py
@@ -636,7 +636,7 @@ def _get_filetreediff_response(self, *, request, project, version, resolver):
         This response is only enabled for external versions,
         we do the comparison between the current version and the latest version.
         """
-        if not version.is_external:
+        if not version.is_external and not settings.RTD_FILETREEDIFF_ALL:
             return None
 
         if not project.addons.filetreediff_enabled:

diff --git a/readthedocs/settings/base.py b/readthedocs/settings/base.py
@@ -53,6 +53,9 @@ class CommunityBaseSettings(Settings):
     DEBUG = True
     RTD_FORCE_SHOW_DEBUG_TOOLBAR = False
 
+    # Build FTD index for all versions
+    RTD_FILETREEDIFF_ALL = False
+
     @property
     def DEBUG_TOOLBAR_CONFIG(self):
         def _show_debug_toolbar(request):

diff --git a/readthedocs/settings/docker_compose.py b/readthedocs/settings/docker_compose.py
@@ -239,5 +239,7 @@ def SOCIALACCOUNT_PROVIDERS(self):
     DATA_UPLOAD_MAX_NUMBER_FIELDS = None
     SUPPORT_EMAIL = "[email protected]"
 
+    RTD_FILETREEDIFF_ALL = "RTD_FILETREEDIFF_ALL" in os.environ
+
 
 DockerBaseSettings.load_settings(__name__)