Skip to content

Handle GitHub Push events with deleted: true in the JSON #6465

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
Dec 18, 2019
Merged

Handle GitHub Push events with deleted: true in the JSON #6465

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da458d3
Handle GitHub Push events with `deleted: true` in the JSON
ericholscher Dec 17, 2019
6d69534
Don't build docs on push with `created: true` either
ericholscher Dec 17, 2019
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
8 changes: 5 additions & 3 deletions readthedocs/api/v2/views/integrations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,21 +359,23 @@ def get_digest(secret, msg):
def handle_webhook(self):
# Get event and trigger other webhook events
action = self.data.get('action', None)
deleted = self.data.get('deleted', False)
event = self.request.META.get(GITHUB_EVENT_HEADER, GITHUB_PUSH)
webhook_github.send(
Project,
project=self.project,
data=self.data,
event=event,
)
# Handle push events and trigger builds
if event == GITHUB_PUSH:
# Don't build a branch if it's a push that was actually a delete
# https://developer.github.com/v3/activity/events/types/#pushevent
if event == GITHUB_PUSH and not deleted:
Copy link
Member

Choose a reason for hiding this comment

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

If created=True this wouldn't trigger a new build, because the version doesn't exist yet in read the docs.

readthedocs.org/readthedocs/core/views/hooks.py

Lines 50 to 52 in 2e67b7d

versions = project.versions_from_branch_name(branch)
for version in versions:

We should check that created is False here too.

Copy link
Member Author

@ericholscher ericholscher Dec 17, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

That's an existing bug though, right? I don't know when we want to trigger a build when a user creates a new branch on a push?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, a push event + deleted or push event + created should trigger a version sync, not a build (because it will fail when deteled=True and it wouldn't to anything if created=True)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, I understand, so we need to check for created on the push as well 👍

try:
branches = [self._normalize_ref(self.data['ref'])]
return self.get_response_push(self.project, branches)
except KeyError:
raise ParseError('Parameter "ref" is required')
if event in (GITHUB_CREATE, GITHUB_DELETE):
if event in (GITHUB_CREATE, GITHUB_DELETE) or (event == GITHUB_PUSH and deleted):
Copy link
Member

Choose a reason for hiding this comment

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

We already subscribe to create and delete events that does the same. But I think this is still useful for users with old webhooks that only have the push event. We should also build when there is a push event with created=True.

return self.sync_versions(self.project)
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 is probably not the most efficient thing we could be doing. We could grab the branch name from the Push and delete it explicitly, but this seemed like the easiest implementation.


if (
Expand Down
20 changes: 20 additions & 0 deletions readthedocs/rtd_tests/tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -909,6 +909,26 @@ def test_github_webhook_for_tags(self, trigger_build):
[mock.call(force=True, version=self.version_tag, project=self.project)],
)

@mock.patch('readthedocs.core.views.hooks.sync_repository_task')
def test_github_webhook_no_build_on_delete(self, sync_repository_task, trigger_build):
client = APIClient()

payload = {'ref': 'master', 'deleted': True}
headers = {GITHUB_EVENT_HEADER: GITHUB_PUSH}
resp = client.post(
'/api/v2/webhook/github/{}/'.format(self.project.slug),
payload,
format='json',
**headers
)
self.assertEqual(resp.status_code, status.HTTP_200_OK)
self.assertFalse(resp.data['build_triggered'])
self.assertEqual(resp.data['project'], self.project.slug)
self.assertEqual(resp.data['versions'], [LATEST])
trigger_build.assert_not_called()
latest_version = self.project.versions.get(slug=LATEST)
sync_repository_task.delay.assert_called_with(latest_version.pk)

@mock.patch('readthedocs.core.views.hooks.sync_repository_task')
def test_github_create_event(self, sync_repository_task, trigger_build):
client = APIClient()
Expand Down