Update build with "Pulling cache" when downloading the cache

Author: humitos

readthedocs/builds/constants.py

@@ -5,13 +5,15 @@
 
 
 BUILD_STATE_TRIGGERED = 'triggered'
+BUILD_STATE_PULLING_CACHE = 'pulling-cache'
 BUILD_STATE_CLONING = 'cloning'
 BUILD_STATE_INSTALLING = 'installing'
 BUILD_STATE_BUILDING = 'building'
 BUILD_STATE_FINISHED = 'finished'
 
 BUILD_STATE = (
     (BUILD_STATE_TRIGGERED, _('Triggered')),
+    (BUILD_STATE_PULLING_CACHE, _('Pulling cache')),
     (BUILD_STATE_CLONING, _('Cloning')),
     (BUILD_STATE_INSTALLING, _('Installing')),
     (BUILD_STATE_BUILDING, _('Building')),

readthedocs/projects/tasks.py

@@ -33,6 +33,7 @@
     BUILD_STATE_CLONING,
     BUILD_STATE_FINISHED,
     BUILD_STATE_INSTALLING,
+    BUILD_STATE_PULLING_CACHE,
     BUILD_STATUS_SUCCESS,
     BUILD_STATUS_FAILURE,
     LATEST,
@@ -93,10 +94,12 @@ class CachedEnvironmentMixin:
 
     """Mixin that pull/push cached environment to storage."""
 
-    def pull_cached_environment(self):
+    def pull_cached_environment(self, environment):
         if not self.project.has_feature(feature_id=Feature.CACHED_ENVIRONMENT):
             return
 
+        environment.update_build(state=BUILD_STATE_PULLING_CACHE)
+
         storage = get_storage_class(settings.RTD_BUILD_ENVIRONMENT_STORAGE)()
         filename = self.version.get_storage_environment_cache_path()
 
@@ -370,7 +373,7 @@ def run(self, version_pk):  # pylint: disable=arguments-differ
                     # repository in this step, and pushing it back will delete
                     # all the other cached things (Python packages, Sphinx,
                     # virtualenv, etc)
-                    self.pull_cached_environment()
+                    self.pull_cached_environment(environment)
                     self.sync_repo(environment)
             return True
         except RepositoryError:
@@ -594,7 +597,7 @@ def run_setup(self, record=True):
                     raise ProjectBuildsSkippedError
                 try:
                     with self.project.repo_nonblockinglock(version=self.version):
-                        self.pull_cached_environment()
+                        self.pull_cached_environment(environment)
                         self.setup_vcs(environment)
                 except vcs_support_utils.LockTimeout as e:
                     self.task.retry(exc=e, throw=False)