Clean storage paths when a version is inactive

Author: stsewd

readthedocs/builds/models.py

@@ -322,6 +322,11 @@ def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
             task=tasks.symlink_project,
             args=[self.project.pk],
         )
+
+        # These resources are not used when a version is inactive
+        if not self.active:
+            tasks.clean_project_resources(self.project, self)
+
         return obj
 
     def delete(self, *args, **kwargs):  # pylint: disable=arguments-differ
@@ -333,10 +338,9 @@ def delete(self, *args, **kwargs):  # pylint: disable=arguments-differ
             args=[self.get_artifact_paths()],
         )
 
-        # Remove build artifacts from storage if the version is not external
+        # Remove resources if the version is not external
         if self.type != EXTERNAL:
-            storage_paths = self.get_storage_paths()
-            tasks.remove_build_storage_paths.delay(storage_paths)
+            tasks.clean_project_resources(self.project, self)
 
         project_pk = self.project.pk
         super().delete(*args, **kwargs)

readthedocs/projects/models.py

@@ -480,16 +480,7 @@ def delete(self, *args, **kwargs):  # pylint: disable=arguments-differ
             args=[(self.doc_path,)],
         )
 
-        # Remove build artifacts from storage
-        storage_paths = []
-        for type_ in MEDIA_TYPES:
-            storage_paths.append(
-                '{}/{}'.format(
-                    type_,
-                    self.slug,
-                )
-            )
-        tasks.remove_build_storage_paths.delay(storage_paths)
+        tasks.clean_project_resources(self)
 
         super().delete(*args, **kwargs)
 
@@ -534,6 +525,19 @@ def get_subproject_urls(self):
         return [(proj.child.slug, proj.child.get_docs_url())
                 for proj in self.subprojects.all()]
 
+    def get_storage_paths(self):
+        """
+        Get the paths of all artifacts used by the project.
+
+        :return: the path to an item in storage
+                 (can be used with ``storage.url`` to get the URL).
+        """
+        storage_paths = [
+            f'{type_}/{self.slug}'
+            for type_ in MEDIA_TYPES
+        ]
+        return storage_paths
+
     def get_storage_path(
             self,
             type_,

readthedocs/projects/tasks.py

@@ -1844,6 +1844,26 @@ def remove_build_storage_paths(paths):
         storage.delete_directory(storage_path)
 
 
+def clean_project_resources(project, version=None):
+    """
+    Delete all extra resources used by `version` of `project`.
+
+    It removes:
+
+    - Artifacts from storage.
+    - Search indexes from ES.
+
+    :param version: Version instance. if isn't given,
+                    all resources of `project` will be deleted.
+    """
+    storage_paths = []
+    if version:
+        version.get_storage_paths()
+    else:
+        storage_paths = project.get_storage_paths()
+    remove_build_storage_paths.delay(storage_paths)
+
+
 @app.task(queue='web')
 def sync_callback(_, version_pk, commit, build, *args, **kwargs):
     """