Skip to content

Use tar to extract cache, write by chunks and new build state #6793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Use tar to extract cache, write by chunks and new build state #6793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5701662
Use `tar` command to extract cached environment
humitos Mar 18, 2020
395317a
Iterate over file chunks and save them on disk
humitos Mar 19, 2020
abd1a3d
Update build with "Pulling cache" when downloading the cache
humitos Mar 19, 2020
f34203d
Migration file for new Build state
humitos Mar 19, 2020
67b25e0
Use storage.open API correctly
humitos Mar 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions readthedocs/builds/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')),
Expand Down
18 changes: 18 additions & 0 deletions readthedocs/builds/migrations/0015_pulling_cache_build_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Generated by Django 2.2.10 on 2020-03-19 03:38

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('builds', '0014_migrate-doctype-from-project-to-version'),
]

operations = [
migrations.AlterField(
model_name='build',
name='state',
field=models.CharField(choices=[('triggered', 'Triggered'), ('pulling-cache', 'Pulling cache'), ('cloning', 'Cloning'), ('installing', 'Installing'), ('building', 'Building'), ('finished', 'Finished')], default='finished', max_length=55, verbose_name='State'),
),
]
21 changes: 8 additions & 13 deletions readthedocs/projects/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
BUILD_STATE_CLONING,
BUILD_STATE_FINISHED,
BUILD_STATE_INSTALLING,
BUILD_STATE_PULLING_CACHE,
BUILD_STATUS_SUCCESS,
BUILD_STATUS_FAILURE,
LATEST,
Expand Down Expand Up @@ -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()

Expand All @@ -119,17 +122,9 @@ def pull_cached_environment(self):
'msg': msg,
}
)
_, tmp_filename = tempfile.mkstemp(suffix='.tar')
remote_fd = storage.open(filename, mode='rb')
with open(tmp_filename, mode='wb') as local_fd:
local_fd.write(remote_fd.read())

with tarfile.open(tmp_filename) as tar:
tar.extractall(self.version.project.doc_path)

# Cleanup the temporary file
if os.path.exists(tmp_filename):
os.remove(tmp_filename)
with tarfile.open(fileobj=remote_fd) as tar:
tar.extracall(self.project.doc_path)

def push_cached_environment(self):
if not self.project.has_feature(feature_id=Feature.CACHED_ENVIRONMENT):
Expand Down Expand Up @@ -369,7 +364,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:
Expand Down Expand Up @@ -591,7 +586,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)
Expand Down