Skip to content

Appropiate logging when a LockTimeout for VCS is reached #4804

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

Merged
merged 2 commits into from
Nov 7, 2018
Merged

Appropiate logging when a LockTimeout for VCS is reached #4804

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0c8405
Appropiate logging when a LockTimeout for VCS is reached
humitos Oct 24, 2018
fa3ce4c
Merge remote-tracking branch 'origin/master' into humitos/lock/approp…
ericholscher Nov 1, 2018
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
42 changes: 40 additions & 2 deletions readthedocs/projects/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@

from .constants import LOG_TEMPLATE
from .exceptions import RepositoryError
from .models import Domain, Feature, ImportedFile, Project
from .models import Domain, ImportedFile, Project
from .signals import (
after_build, after_vcs, before_build, before_vcs, files_changed)

Expand Down Expand Up @@ -218,10 +218,24 @@ def run(self, version_pk): # pylint: disable=arguments-differ
except RepositoryError:
# Do not log as ERROR handled exceptions
log.warning('There was an error with the repository', exc_info=True)
except vcs_support_utils.LockTimeout:
log.info(
'Lock still active: project=%s version=%s',
self.project.slug,
self.version.slug,
)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should raise VersionLockedError here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this task is used only for syncing the repo, we don't need to raise the exception here. It will return False when it fails and that's all what we need.

except Exception:
# Catch unhandled errors when syncing
log.exception(
'An unhandled exception was raised during VCS syncing',
extra={
'stack': True,
'tags': {
'project': self.project.slug,
'version': self.version.slug,
},
},

)
return False

Expand Down Expand Up @@ -548,7 +562,31 @@ def setup_vcs(self):
version=self.version.slug,
msg='Updating docs from VCS',
))
self.sync_repo()
try:
self.sync_repo()
except RepositoryError:
# Do not log as ERROR handled exceptions
log.warning('There was an error with the repository', exc_info=True)
except vcs_support_utils.LockTimeout:
log.info(
'Lock still active: project=%s version=%s',
self.project.slug,
self.version.slug,
)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, we need to raise a proper exception on each different case.

except Exception:
# Catch unhandled errors when syncing
log.exception(
'An unhandled exception was raised during VCS syncing',
extra={
'stack': True,
'tags': {
'build': self.build['id'],
'project': self.project.slug,
'version': self.version.slug,
},
},
)

commit = self.project.vcs_repo(self.version.slug).commit
if commit:
self.build['commit'] = commit
Expand Down