Redirect to build detail post manual build #4622

ba11b0y · 2018-09-08T07:48:02Z

Fixes #4359.
Also sorted imports on running pre-commit hook and some minor modifications to comply with flake8.

stsewd

Thanks for your contribution!

stsewd · 2018-09-10T18:18:41Z

readthedocs/builds/views.py



 class BuildList(BuildBase, BuildTriggerMixin, ListView):

    def get_context_data(self, **kwargs):
        context = super(BuildList, self).get_context_data(**kwargs)

-        active_builds = self.get_queryset().exclude(state="finished").values('id')
+        active_builds = self.get_queryset().exclude(state='finished'
+                                                    ).values('id')


This line is wrapped in a weird way, If this is from pre-commit I think we can just format this manually. /cc @humitos

Yes it was the result of the pre-commit hook.

yup, this is an indenting pattern we don't support.

yapf sometime fails with weird lines.

I check them manually sometimes in a very fast way and decide to not include them when it happens.

Please, fix this yapf indent mistake.

stsewd · 2018-09-10T18:22:21Z

readthedocs/builds/views.py

-        return HttpResponseRedirect(reverse('builds_project_list', args=[project.slug]))
+        build_pk = project.builds.first().pk
+        return HttpResponseRedirect(
+            reverse('builds_detail', args=[project.slug, build_pk])


We may want a test for this, I'll be testing this manually later

I think there is a better way to get the pk of the build we just created. project.builds.first() is not explicit enough i feel. trigger_build calls prepare_build, which is where the build object is created. Perhaps we already have access to the build pk on the task signature return somehow?

I will add a commit. Busy with exams right now.

agjohnson

Looks good, +1 on tests for this. Also if we can get an explicit build id, I think that makes for the most guaranteed UX.

agjohnson · 2018-09-19T19:17:38Z

readthedocs/builds/views.py

-        return HttpResponseRedirect(reverse('builds_project_list', args=[project.slug]))
+        build_pk = project.builds.first().pk
+        return HttpResponseRedirect(
+            reverse('builds_detail', args=[project.slug, build_pk])


I think there is a better way to get the pk of the build we just created. project.builds.first() is not explicit enough i feel. trigger_build calls prepare_build, which is where the build object is created. Perhaps we already have access to the build pk on the task signature return somehow?

ba11b0y · 2018-09-27T15:32:41Z

@agjohnson I am unable to get the result of the task since celery gives a runtime warning when task_always_eager is True.

res = trigger_build(project=project, version=version)
res = AsyncResult(res.task_id)
res.get() # *** RuntimeError: Cannot retrieve result with task_always_eager enabled

A related PR at celery tries to change it to a RuntimeWarning

agjohnson · 2018-09-27T16:06:29Z

We don't want .get() anyways, as that is blocking. Poking around I guess we don't get the signature back with EagerResult from trigger_build return currently. If we have the signature, we can do:

signature = prepare_build(proj)
build_pk = signature.get('kwargs', {}).get('build_pk')

This might need to be verified, but I don't think we ever use the return from trigger_build. If not, we can either:

Make the return the signature from prepare_build
Make the return a tuple including the signature from prepare_build

Then we can easily get the build_pk from the signature

ba11b0y · 2018-10-01T06:15:46Z

@agjohnson I have pushed a commit which returns a tuple now and uses the signature to fetch the build_pk. Should I squash the commits? I am sorry I didn't rebase before commiting.
Also I don't know search tests are failing

humitos · 2018-10-01T09:32:35Z

There is a problem with the PR since it says that ~1500 files were modified :/

Could you please rebase your changes against master and check that it's correct, please?

ba11b0y · 2018-10-01T12:24:10Z

@humitos Sorry. Done now. I still don't know why the tests fail here.

humitos

Thanks for your contribution!

This PR looks good to me.

I'm marking as Request changes because a test case is needed. Once the test is added, I would be ready to merge from my point of view.

Also, I mentioned some small style changes to be considered.

humitos · 2018-10-01T12:29:55Z

readthedocs/core/utils/__init__.py

@@ -172,7 +172,7 @@ def trigger_build(project, version=None, record=True, force=False):
        # Current project is skipped
        return None

-    return update_docs_task.apply_async()
+    return (update_docs_task.apply_async(), update_docs_task)


The docstring needs to be updated accordingly.

Yeah. Missed it. Also is the AsyncResult promise necessary? I don't find any use of returning it from the function.

It's not used, I think.

It returns the async result since it's what it creates and could be useful to extend this from outside.

@humitos Should I create a new test or modify the existing tests. Also the existing tests don't actually use any return from trigger_build, so I am a bit confused.

Modify the test and update the docstring to reflect your changes.

@humitos Sorry but I still can't figure out what to modify in test_core_utils or in other tests since they do not utilize the build_pk

@humitos @agjohnson Ping. Need some help with the tests.

I still can't figure out what to modify in test_core_utils or in other tests since they do not utilize the build_pk.

readthedocs/builds/views.py

humitos · 2018-10-01T12:32:03Z

readthedocs/builds/views.py



 class BuildList(BuildBase, BuildTriggerMixin, ListView):

    def get_context_data(self, **kwargs):
        context = super(BuildList, self).get_context_data(**kwargs)

-        active_builds = self.get_queryset().exclude(state="finished").values('id')
+        active_builds = self.get_queryset().exclude(state='finished'
+                                                    ).values('id')


Please, fix this yapf indent mistake.

ericholscher · 2018-11-02T20:56:51Z

I've added a test here. I think it should be 💯

codecov · 2018-11-02T21:15:16Z

Codecov Report

Merging #4622 into master will increase coverage by 0.05%.
The diff coverage is 92.3%.

@@            Coverage Diff             @@
##           master    #4622      +/-   ##
==========================================
+ Coverage   76.42%   76.47%   +0.05%     
==========================================
  Files         158      158              
  Lines        9992     9992              
  Branches     1262     1262              
==========================================
+ Hits         7636     7641       +5     
+ Misses       2015     2009       -6     
- Partials      341      342       +1

Impacted Files	Coverage Δ
readthedocs/builds/views.py	`96% <100%> (+10.28%)`	⬆️
readthedocs/projects/views/private.py	`80.1% <80%> (ø)`	⬆️
readthedocs/core/utils/__init__.py	`74.73% <85.71%> (-0.27%)`	⬇️

…redirect-to-build-detail

humitos · 2018-11-06T09:48:35Z

@invinciblycool THANKS!

stsewd reviewed Sep 10, 2018

View reviewed changes

agjohnson reviewed Sep 19, 2018

View reviewed changes

ba11b0y force-pushed the fix/redirect-to-build-detail branch from a807a00 to 768779e Compare October 1, 2018 12:13

humitos requested changes Oct 1, 2018

View reviewed changes

ba11b0y force-pushed the fix/redirect-to-build-detail branch from 5729816 to bdc332b Compare October 1, 2018 20:57

RichardLitt added the Needed: tests Tests are required label Oct 2, 2018

ba11b0y force-pushed the fix/redirect-to-build-detail branch from 94e13af to 754b60d Compare October 12, 2018 13:01

ba11b0y and others added 4 commits November 2, 2018 15:58

Redirect to build detail post manual build

8e1f378

Return signature from trigger build and use it to fetch build_pk

b380c90

Update dosctring and fix yapf errors

51196b1

Add test for build redirect

c972fb2

ericholscher force-pushed the fix/redirect-to-build-detail branch from 51226ed to c972fb2 Compare November 2, 2018 20:58

Fix usage of prepare_build

de1223b

Merge remote-tracking branch 'origin/master' into invinciblycool-fix/…

cffe875

…redirect-to-build-detail

ericholscher merged commit 1057273 into readthedocs:master Nov 5, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redirect to build detail post manual build #4622

Redirect to build detail post manual build #4622

ba11b0y commented Sep 8, 2018

stsewd left a comment

stsewd Sep 10, 2018

ba11b0y Sep 10, 2018

agjohnson Sep 19, 2018

humitos Oct 1, 2018

humitos Oct 1, 2018

stsewd Sep 10, 2018

agjohnson Sep 19, 2018

ba11b0y Sep 24, 2018

agjohnson left a comment

agjohnson Sep 19, 2018

ba11b0y commented Sep 27, 2018

agjohnson commented Sep 27, 2018

ba11b0y commented Oct 1, 2018 •

edited

Loading

humitos commented Oct 1, 2018

ba11b0y commented Oct 1, 2018

humitos left a comment

humitos Oct 1, 2018

ba11b0y Oct 1, 2018

humitos Oct 2, 2018

ba11b0y Oct 5, 2018

humitos Oct 9, 2018

ba11b0y Oct 17, 2018

ba11b0y Oct 22, 2018

humitos Oct 1, 2018

ericholscher commented Nov 2, 2018

codecov bot commented Nov 2, 2018 •

edited

Loading

humitos commented Nov 6, 2018

Redirect to build detail post manual build #4622

Redirect to build detail post manual build #4622

Conversation

ba11b0y commented Sep 8, 2018

stsewd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agjohnson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ba11b0y commented Sep 27, 2018

agjohnson commented Sep 27, 2018

ba11b0y commented Oct 1, 2018 • edited Loading

humitos commented Oct 1, 2018

ba11b0y commented Oct 1, 2018

humitos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericholscher commented Nov 2, 2018

codecov bot commented Nov 2, 2018 • edited Loading

Codecov Report

humitos commented Nov 6, 2018

ba11b0y commented Oct 1, 2018 •

edited

Loading

codecov bot commented Nov 2, 2018 •

edited

Loading