Add UI element for resyncing versions from VCS

[ericholscher]

Currently we have a task that resyncs Versions from VCS:

readthedocs.org/readthedocs/projects/tasks.py

Line 217 in 7fda1c0

class SyncRepositoryTaskStep(SyncRepositoryMixin):

We should create a button on the Versions page (/projects//versions/) that lets users automatically trigger a resync. We usually try and resync versions whenever we get a new webhook from GitHub, but there are a few cases where this doesn't work:

• A user doesn't have a webhook setup for their repo (eg. non-supported VCS)
• The users webhook isn't configured to send us pings when they push a new tag/branch
• A random failure happens either in the webhook code from the provider, or on our side to process it

Normally we tell users to just do a build of their docs to fix this, but I think we should add a UI element to resync them, so it's more obvious how to handle this situation.

[saadmk11]

@ericholscher Do we want this to behave same as build list page Build Version button?

readthedocs.org/readthedocs/builds/views.py

Lines 50 to 80 in 3f3488f

	def post(self, request, project_slug):
	project = get_object_or_404(Project, slug=project_slug)
	if not AdminPermission.is_admin(request.user, project):
	return HttpResponseForbidden()
	version_slug = request.POST.get('version_slug')
	version = get_object_or_404(
	Version.internal.all(),
	project=project,
	slug=version_slug,
	)
	update_docs_task, build = trigger_build(
	project=project,
	version=version,
	)
	if (update_docs_task, build) == (None, None):
	# Build was skipped
	messages.add_message(
	request,
	messages.WARNING,
	"This project is currently disabled and can't trigger new builds.",
	)
	return HttpResponseRedirect(
	reverse('builds_project_list', args=[project.slug]),
	)
	return HttpResponseRedirect(
	reverse('builds_detail', args=[project.slug, build.pk]),
	)

And Will this Resync Button be available for all the version or only the active versions?

[stsewd]

@saadmk11 the Resync button is only one for each project. The task only clones the repo and parse the tags and branches, so the versions are in sync.

[ericholscher]

I had a user request resyncing via API, so they could ensure branches were synced in their CI. This could be a good first step towards an implementation, which the frontend UI element could just hit.

[agjohnson]

Yeah, an API endpoint would be perfect.

See readthedocs/ext-theme#65 for the dashboard implementation:

• Add resync repository button in the version creation view template ext-theme#65

[ericholscher]

Refs https://app.frontapp.com/open/cnv_nclep3b?key=ynhl4BBbPEPQUA3m1r8DTc9oWRq5xVvi

[ericholscher]

Looking into this, we already have an API endpoint for this:

readthedocs.org/readthedocs/api/v2/views/task_views.py

Lines 38 to 52 in bf02353

	@decorators.api_view(["POST"])
	@decorators.permission_classes((permissions.IsAuthenticated,))
	@decorators.renderer_classes((JSONRenderer,))
	def sync_remote_repositories(request):
	"""Trigger a re-sync of remote repositories for the user."""
	result = tasks.sync_remote_repositories.delay(
	user_id=request.user.id,
	)
	task_id = result.task_id
	return Response(
	{
	"task_id": task_id,
	"url": reverse("api_job_status", kwargs={"task_id": task_id}),
	}
	)

[humitos]

Yes, we have this button in the old dashboard. This endpoint does not work because it requires Celery storing the results and we removed that feature because of... Celery-reasons.

The current button in the old dashboard just fakes it and waits ~3s, IIRC.