Show "Pushing cache" status before finishing the build

Author: humitos

readthedocs/builds/constants.py

@@ -9,6 +9,7 @@
 BUILD_STATE_CLONING = 'cloning'
 BUILD_STATE_INSTALLING = 'installing'
 BUILD_STATE_BUILDING = 'building'
+BUILD_STATE_PUSHING_CACHE = 'pushing-cache'
 BUILD_STATE_FINISHED = 'finished'
 
 BUILD_STATE = (
@@ -17,6 +18,7 @@
     (BUILD_STATE_CLONING, _('Cloning')),
     (BUILD_STATE_INSTALLING, _('Installing')),
     (BUILD_STATE_BUILDING, _('Building')),
+    (BUILD_STATE_PUSHING_CACHE, _('Pushing cache')),
     (BUILD_STATE_FINISHED, _('Finished')),
 )
 

readthedocs/doc_builder/environments.py

@@ -662,7 +662,7 @@ def done(self):
             self.build['state'] == BUILD_STATE_FINISHED
         )
 
-    def update_build(self, state=None):
+    def update_build(self, state=None, force=False):
         """
         Record a build by hitting the API.
 
@@ -747,6 +747,8 @@ def update_build(self, state=None):
             or (self.done and not self.successful)
             # Otherwise, are we explicitly to not update?
             or self.update_on_success
+            # Explicit force the update
+            or force
         )
         if update_build:
             try:

readthedocs/projects/tasks.py

@@ -34,6 +34,7 @@
     BUILD_STATE_FINISHED,
     BUILD_STATE_INSTALLING,
     BUILD_STATE_PULLING_CACHE,
+    BUILD_STATE_PUSHING_CACHE,
     BUILD_STATUS_SUCCESS,
     BUILD_STATUS_FAILURE,
     LATEST,
@@ -134,10 +135,12 @@ def pull_cached_environment(self, environment):
             if os.path.exists(tmp_filename):
                 os.remove(tmp_filename)
 
-    def push_cached_environment(self):
+    def push_cached_environment(self, environment):
         if not self.project.has_feature(feature_id=Feature.CACHED_ENVIRONMENT):
             return
 
+        environment.update_build(state=BUILD_STATE_PUSHING_CACHE)
+
         project_path = self.project.doc_path
         directories = [
             'checkouts',
@@ -673,6 +676,7 @@ def run_build(self, record):
             build=self.build,
             record=record,
             environment=env_vars,
+            update_on_success=False,
 
             # Pass ``start_time`` here to not reset the timer
             start_time=self.build_start_time,
@@ -756,7 +760,7 @@ def run_build(self, record):
             self.send_notifications(self.version.pk, self.build['id'], email=False)
 
             # Push cached environment on success for next build
-            self.push_cached_environment()
+            self.push_cached_environment(self.build_env)
 
             if self.commit:
                 send_external_build_status(
@@ -783,6 +787,7 @@ def run_build(self, record):
                     }
                 )
 
+        self.build_env.update_build(BUILD_STATE_FINISHED, force=True)
         build_complete.send(sender=Build, build=self.build_env.build)
 
     @staticmethod