Remove files from cloud storage when version is wiped.

docs/faq.rst

@@ -245,6 +245,13 @@ What commit of Read the Docs is in production?
 We deploy readthedocs.org from the `rel` branch in our GitHub repository. You can see the latest commits that have been deployed by looking on GitHub: https://github.com/readthedocs/readthedocs.org/commits/rel
 
 
+How can I remove stale results from the search?
+-----------------------------------------------
+
+If the search results contains stale/outdated results,
+you can update the search index by :doc:`wiping the build environment <guides/wipe-environment>` and then rebuilding your docs.
+
+
 How can I avoid search results having a deprecated version of my docs?
 ----------------------------------------------------------------------
 

readthedocs/builds/admin.py

@@ -20,7 +20,7 @@
     VersionAutomationRule,
 )
 from readthedocs.core.utils import trigger_build
-from readthedocs.core.utils.general import wipe_version_via_slugs
+from readthedocs.core.utils.general import _wipe_version_helper
 from readthedocs.projects.models import HTMLFile
 from readthedocs.search.utils import _indexing_helper
 
@@ -114,7 +114,7 @@ class VersionAdmin(admin.ModelAdmin):
     def wipe_selected_versions(self, request, queryset):
         """Wipes the selected versions."""
         for version in queryset:
-            wipe_version_via_slugs(
+            _wipe_version_helper(
                 version_slug=version.slug,
                 project_slug=version.project.slug
             )

readthedocs/core/utils/general.py

@@ -2,15 +2,23 @@
 
 import os
 
+from django.conf import settings
+from django.core.files.storage import get_storage_class
 from django.shortcuts import get_object_or_404
 
 from readthedocs.core.utils import broadcast
 from readthedocs.projects.tasks import remove_dirs
 from readthedocs.builds.models import Version
 
 
-def wipe_version_via_slugs(version_slug, project_slug):
-    """Wipes the given version of a given project."""
+def _wipe_version_helper(version_slug, project_slug):
+    """
+    Wipes the given version of a project.
+
+    It does two things:
+    * Clears the `checkouts`, `envs`, and `conda` direcories (if exist).
+    * Removes the html files from cloud storage.
+    """
     version = get_object_or_404(
         Version,
         slug=version_slug,
@@ -23,3 +31,17 @@ def wipe_version_via_slugs(version_slug, project_slug):
     ]
     for del_dir in del_dirs:
         broadcast(type='build', task=remove_dirs, args=[(del_dir,)])
+
+    _clear_html_files_from_cloud_storage(version)
+
+
+def _clear_html_files_from_cloud_storage(version):
+    """Removes html files from cloud storage for a given version of a project."""
+
+    storage = get_storage_class(settings.RTD_BUILD_MEDIA_STORAGE)()
+    storage_path = version.project.get_storage_path(
+        type_='html',
+        version_slug=version.slug,
+        include_file=False,
+    )
+    storage.delete_directory(storage_path)

readthedocs/core/views/__init__.py

@@ -16,7 +16,7 @@
 from django.views.static import serve as static_serve
 
 from readthedocs.builds.models import Version
-from readthedocs.core.utils.general import wipe_version_via_slugs
+from readthedocs.core.utils.general import _wipe_version_helper
 from readthedocs.core.resolver import resolve_path
 from readthedocs.core.symlink import PrivateSymlink, PublicSymlink
 from readthedocs.projects.constants import PRIVATE
@@ -72,7 +72,7 @@ def wipe_version(request, project_slug, version_slug):
         raise Http404('You must own this project to wipe it.')
 
     if request.method == 'POST':
-        wipe_version_via_slugs(
+        _wipe_version_helper(
             version_slug=version_slug,
             project_slug=project_slug,
         )

readthedocs/rtd_tests/tests/test_core_utils.py

@@ -11,7 +11,7 @@
 from readthedocs.builds.constants import LATEST
 from readthedocs.builds.models import Version
 from readthedocs.core.utils import slugify, trigger_build
-from readthedocs.core.utils.general import wipe_version_via_slugs
+from readthedocs.core.utils.general import _wipe_version_helper
 from readthedocs.projects.models import Project
 from readthedocs.projects.tasks import remove_dirs
 
@@ -200,8 +200,8 @@ def test_slugify(self):
         )
 
     @mock.patch('readthedocs.core.utils.general.broadcast')
-    def test_wipe_version_via_slug(self, mock_broadcast):
-        wipe_version_via_slugs(
+    def test_wipe_version_helper(self, mock_broadcast):
+        _wipe_version_helper(
             version_slug=self.version.slug,
             project_slug=self.version.project.slug
         )
@@ -221,20 +221,20 @@ def test_wipe_version_via_slug(self, mock_broadcast):
         )
 
     @mock.patch('readthedocs.core.utils.general.broadcast')
-    def test_wipe_version_via_slug_wrong_param(self, mock_broadcast):
+    def test_wipe_version_helper_wrong_param(self, mock_broadcast):
         self.assertFalse(Version.objects.filter(slug='wrong-slug').exists())
         with self.assertRaises(Http404):
-            wipe_version_via_slugs(
+            _wipe_version_helper(
                 version_slug='wrong-slug',
                 project_slug=self.version.project.slug
             )
         mock_broadcast.assert_not_called()
 
     @mock.patch('readthedocs.core.utils.general.broadcast')
-    def test_wipe_version_via_slugs_same_version_slug_with_diff_proj(self, mock_broadcast):
+    def test_wipe_version_helper_same_version_slug_with_diff_proj(self, mock_broadcast):
         project_2 = get(Project)
         version_2 = get(Version, project=project_2, slug=self.version.slug)
-        wipe_version_via_slugs(
+        _wipe_version_helper(
             version_slug=version_2.slug,
             project_slug=project_2.slug,
         )