Bug 894137 - BEAKER: [RFE] Add ability to provide a direct reference link to a RecipeSet within a job
Summary: BEAKER: [RFE] Add ability to provide a direct reference link to a RecipeSet w...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Beaker
Classification: Retired
Component: web UI
Version: 0.9
Hardware: Unspecified
OS: Unspecified
low
unspecified
Target Milestone: 23.0
Assignee: Dan Callaghan
QA Contact:
URL:
Whiteboard: UX
: 825220 1187005 (view as bug list)
Depends On: 1263917
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-01-10 20:16 UTC by PaulB
Modified: 2018-02-06 00:41 UTC (History)
13 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2016-07-07 23:09:36 UTC
Embargoed:


Attachments (Terms of Use)

Comment 4 Nick Coghlan 2013-04-15 03:35:01 UTC
This RFE covers two elements:

* provide HTML anchors in the jobs pages so that URLs in the following form act as a direct link to individual recipe sets within the job:

    https://beaker.example.com/jobs/123456#set987654

* Make the recipe set labels in the jobs results page references to these anchors so you can easily get the direct link through "Copy link location" or just by following the link.

The overall behaviour should be essentially the same as that for links to individual tasks within a recipe (as in https://beaker.example.com/recipes/654321#task456789)

Comment 5 Dan Callaghan 2014-12-16 07:31:31 UTC
*** Bug 825220 has been marked as a duplicate of this bug. ***

Comment 6 Nick Coghlan 2015-01-29 07:27:53 UTC
*** Bug 1187005 has been marked as a duplicate of this bug. ***

Comment 7 PaulB 2015-02-23 15:50:06 UTC
All,
Is this request still on the radar?

Best,
-pbunyan

Comment 8 Dan Callaghan 2015-02-24 01:27:50 UTC
(In reply to PaulB from comment #7)
> Is this request still on the radar?

Same as bug 1122682, we are planning to address this as part of the upcoming job page improvements. There is a description of the proposed changes here:

https://beaker-project.org/dev/proposals/job-page-improvements.html

and we are working on a prototype which we will use to collect more feedback.

Comment 9 Dan Callaghan 2015-09-29 00:13:06 UTC
Note to self: there is an existing id on the RS tables like #RS_123, even though it's a bit useless because it's not indicated anywhere and it doesn't highlight or anything.

The implementation for this should either reuse the same id format RS_123, or else handle anchors of that format and convert them, to preserve any URLs which people might have constructed by hand using the old ids as anchors.

Comment 10 Dan Callaghan 2015-09-30 00:33:08 UTC
Note to self: update ReciepSet#toHTML Backbone model to use the new anchor.

Comment 11 Dan Callaghan 2015-11-27 04:17:54 UTC
http://gerrit.beaker-project.org/4509

Comment 12 Mike McCune 2016-03-28 22:26:18 UTC
This bug was accidentally moved from POST to MODIFIED via an error in automation, please see mmccune with any questions

Comment 13 Dan Callaghan 2016-04-05 07:58:17 UTC
The results-reporting-improvements-take3 branch has been merged to develop.

Comment 15 PaulB 2016-04-07 16:04:07 UTC
Dan,
I ran a test with two recipeSets:
 https://beaker-devel.app.eng.bos.redhat.com/jobs/9414

Unfortunately, this does not resolve the issue :/
If I have a failure within a GuestRecipe, having the ability to
update a BZ with a single link to the entire recipeSet would be beneficial.

For instance in job 9414 - lets just say my "KVM x86_64 2 vcpus Guest" had 
failed, anyone investigating the job would want to see log for the KVM host
and be aware that there are multiple Guests being tested on the KVM host.
I have no way of providing a link to RS:11955, which provides the whole picture.

Also, this layout in unfortunately a regression when it comes to reviewing the job. I am restricted to viewing a single recipe in a window at at a time. I have to open the HOST recipe in one window and then each Guest recipe in a separate window. Bouncing back and forth during Guest testing investigation
in a Job with numerous "Guest testing recipeSets" with different probable failures would get a bit ugly.

I much prefer the current view, where I can look at all the recipes in a recipeSet in the same window:
https://beaker.engineering.redhat.com/jobs/1290479
RS:2097517

In the current view I can open up and dig into the HOST and Guest logs in the same window. Looking at the whole picture when troubleshooting Guest testing issues is preferred.

Sorry for the bummer feedback, Dan.

Best,
-pbunyan

Comment 16 Dan Callaghan 2016-04-13 07:56:07 UTC
(In reply to PaulB from comment #15)
> For instance in job 9414 - lets just say my "KVM x86_64 2 vcpus Guest" had 
> failed, anyone investigating the job would want to see log for the KVM host
> and be aware that there are multiple Guests being tested on the KVM host.
> I have no way of providing a link to RS:11955, which provides the whole
> picture.

There is a way: if you hover over RS:11955 a link icon appears to the left of it, which is the permalink to that recipe set. If you right-click on the link and Copy URL you will get:

https://beaker-devel.app.eng.bos.redhat.com/jobs/9414#set11955

which you can then share. When you (or anyone else) click that link with the #set11955 anchor, you should see RS:11995 highlighted in yellow.

We modelled this on the approach used by Github and Sphinx, where hovering over a heading shows an icon for a permalink. On Github it's a link icon appearing to the left, in Sphinx it's a paragraph icon appearing at the right.

However I'm assuming you didn't realise that when you were trying out the new page, Paul. So that's probably a sign we need to come up with some way to make it more obvious...

> Also, this layout in unfortunately a regression when it comes to reviewing
> the job. I am restricted to viewing a single recipe in a window at at a
> time. I have to open the HOST recipe in one window and then each Guest
> recipe in a separate window. Bouncing back and forth during Guest testing
> investigation
> in a Job with numerous "Guest testing recipeSets" with different probable
> failures would get a bit ugly.
> 
> I much prefer the current view, where I can look at all the recipes in a
> recipeSet in the same window:
> https://beaker.engineering.redhat.com/jobs/1290479
> RS:2097517
> 
> In the current view I can open up and dig into the HOST and Guest logs in
> the same window. Looking at the whole picture when troubleshooting Guest
> testing issues is preferred.
> 
> Sorry for the bummer feedback, Dan.

No worries, we are still glad to hear it. And thank you for testing. We have heard this same feedback from some other people as well (that they prefer viewing all recipe results on a single page instead of opening multiple recipe pages).

We still believe that the cramming all recipes' results onto the job page is not good for usability. We are planning to build a separate page which is specifically for comparing results across recipes in a multi-host recipe set -- ideally with all recipes shown in a timeline kind of view. However we won't be implementing that before 23.0.

In the near term, for people who prefer the old job page, we have added a user preference to switch back to that until we can come up with some UI to satisfy those needs.

I'm happy to discuss further with you Paul, especially if you have any suggestions about the timeline interface for viewing multi-host recipe sets, but let's take it to the mailing list. We are getting a bit off-topic for this bug now.

Comment 18 Dan Callaghan 2016-04-15 05:37:45 UTC
Based on the above, I am wondering what we can do to make these links more obvious and intuitive.

The reason why we only show them on hover is to avoid visual clutter -- you don't need to see the little link unless you are trying to grab a URL to copy-paste to someone else. Also in Github's case, the links sit left of each heading outside the margin so showing them all the time would be visually distracting.

However just showing the link icon when you hover over RS:123 might not be a good choice, since that's such a small hit target. Could we should the link any time you are hovering over any part of the entire RS row? Or even further, when you are hovering over the RS row *and* any of the recipe rows inside the RS?

Comment 19 Ales Zelinka 2016-04-15 15:06:51 UTC
(In reply to Dan Callaghan from comment #16)
> There is a way: if you hover over RS:11955 a link icon appears to the left
> of it, which is the permalink to that recipe set. If you right-click on the
> link and Copy URL you will get:
> 
> https://beaker-devel.app.eng.bos.redhat.com/jobs/9414#set11955

(In reply to Dan Callaghan from comment #18)
> Based on the above, I am wondering what we can do to make these links more
> obvious and intuitive.

I must be missing something. Why not make the actual "RS:1236" text a link to the recipe set?

Comment 20 Dan Callaghan 2016-04-17 22:43:58 UTC
(In reply to Ales Zelinka from comment #19)
> I must be missing something. Why not make the actual "RS:1236" text a link
> to the recipe set?

We were avoiding that because then it is difficult to copy-paste the RS:123 identifier -- for example if you wanted to paste it to bkr job-watch or something like that.

However it's a good point -- maybe the need to copy-paste is not important enough, and we should just simplify the whole link hover thing by turning the RS:123 itself into a link.

Comment 21 Ales Zelinka 2016-04-18 09:20:13 UTC
(In reply to Dan Callaghan from comment #20)
> (In reply to Ales Zelinka from comment #19)
> > I must be missing something. Why not make the actual "RS:1236" text a link
> > to the recipe set?
> 
> We were avoiding that because then it is difficult to copy-paste the RS:123
> identifier -- for example if you wanted to paste it to bkr job-watch or
> something like that.
> However it's a good point -- maybe the need to copy-paste is not important
> enough, and we should just simplify the whole link hover thing by turning
> the RS:123 itself into a link.

I agree. And it would be consistent with the way recipes are presented (already a simple link).

Comment 22 Dan Callaghan 2016-04-19 01:33:11 UTC
(In reply to Ales Zelinka from comment #21)
> I agree. And it would be consistent with the way recipes are presented
> (already a simple link).

Well there is an important difference between the RS:123 links and the R:123 links. The RS:123 links are just links back to themselves ("permalinks" in old school blogging terminology), you don't want to actually follow them, so they don't need to be directly clickable nor should they look like a normal hyperlink. Whereas the R:123 links are links off to different pages, so you *do* really need to follow those and they should appear like regular hyperlinks.

Comment 24 Dan Callaghan 2016-07-07 23:09:36 UTC
Beaker 23.0 has been released.


Note You need to log in before you can comment on or make changes to this bug.