Closed Bug 1030686 Opened 11 years ago Closed 11 years ago

Add keyboard shortcuts for failure classification

Categories

(Tree Management :: Treeherder, enhancement, P1)

Product:
Tree Management
Component:
Treeherder
Type:
enhancement

Tracking

(Not tracked)

Status:
VERIFIED FIXED

People

(Reporter: automatedtester, Assigned: jfrench)

References

(
URL
)

Details

Attachments

(3 files)

treeherder-ui-relatedBugAddition-PR#281
49 bytes, text/x-github-pull-request
camd
: review+
Details | Review
treeherder-ui-saveClassification-PR#286
49 bytes, text/x-github-pull-request
camd
: review+
Details | Review
treeherder-ui-commentAddition-PR#304
49 bytes, text/x-github-pull-request
camd
: review+
Details | Review
We have some keyboard shortcuts but it would be better for a11y and sheriff productivity if they could do the entire process without having to use a mouse. Saving classifications and picking bugs to be added to the classification are the first ones to start on
We discussed banning the word "starring" for treeherder, since it requires so much in-knowledge to grok, so we proposed using "classifying", "classification" to describe the act of assigning reasons/annotations to failures :-)
Summary: Allow "starring" without having to use the keyboard → Allow classification without having to use the keyboard
Summary: Allow classification without having to use the keyboard → Allow failure classification without having to use the keyboard
Summary: Allow failure classification without having to use the keyboard → Allow failure classification without having to use the mouse
Severity: normal → enhancement
OS: Mac OS X → All
Priority: -- → P3
Hardware: x86 → All
Priority: P3 → P2
Summary: Allow failure classification without having to use the mouse → Add keyboard shortcuts for failure classification
I think the shortcuts still needing to be added are something to act as the "Save" button and something to bring keyboard focus to the "Classification" textarea. In TBPL, 'c' would bring up the "Add a comment" dialog, which would be the equivalent of focusing the "classification" textarea. 'C' also does the TBPL equivalent of adding the currently selected job to the pinboard, so I can just cycle through failures with n/p or j/k, press 'c' when I'm on the failure I want to classify, type in whatever bug number or backout revision is needed into the classification field, then press Ctrl-Enter to submit the classification. All without leaving the keyboard. I guess in Treeherder's case, I would cycle through failures with n/p or j/k, come across a failure I need to classify, and press 'c'. At this point, the currently selected job would become pinned if it was not already pinned, the pinboard section would become visible if it wasn't already visible, and the Classification textarea would become focused for typing (or possibly the "related bugs" '+' button could be clicked so I can type in a bug number into that section instead of the Classification textarea?). From there, I could type, paste or drag in whatever classification text is needed for this failure. Then Ctrl-Enter or something else could trigger the "Save" button. Needinfoing the sheriffs to confirm that this is the desired workflow and to add whatever other keyboard shortcuts are needed to resolve this bug.
Flags: needinfo?(ryanvm)
Flags: needinfo?(philringnalda)
Flags: needinfo?(emorley)
Offhand that sounds generally like I'd expect. Obviously we can start with that and tweak as needed from there too.
Flags: needinfo?(ryanvm)
Yeah wfm
Flags: needinfo?(emorley)
That's all I routinely need, too.
Flags: needinfo?(philringnalda)
Raising priority based on sheriffs top-picks of P2s.
Priority: P2 → P1
(In reply to Wes Kocher (:KWierso) from comment #2) > and the Classification textarea would become focused for typing (or possibly the > "related bugs" '+' button could be clicked so I can type in a bug number > into that section instead of the Classification textarea?) Hi guys, is there consensus on which of the two things you would like to happen here? ie. the classification textarea highlighted, or a related bugs input opened.
Flags: needinfo?(ryanvm)
Flags: needinfo?(philringnalda)
Flags: needinfo?(kwierso)
For me, both. Despite the design sort of thinking that it took tbpl's textarea and split it up into three parts, the part where you put bug numbers, the part where you put "i" for infra, and the part where you type random things, for my starring purposes it split starring into three separate and almost never overlapping workflows: * I like a suggestion, space to pin and focus nothing (though I yearn for someone to make selecting suggestions something that can take focus, like a checkbox), mouse to select, ctrl+enter to save * I have a bug number in my clipboard, R to pin and click the related bugs + and focus the added bug number input, paste the bug number, ctrl+enter to save * I have something to type, C to pin and focus the textarea, type something or paste the backout cset hash, shift+tab to change the classification, ctrl+enter to save So I think until we get the Third System which reunifies things and recognizes when you type bug numbers and when you type "infra", I think we need to remember and choose among three shortcuts for "start doing something about starring this."
Flags: needinfo?(philringnalda)
So when depressing the letter "c" for this new functionality, given the choice of a) focusing the bug entry field, or b) focusing the classification text area, you are asking for the classification text area to be focused, correct?
For clarification above, afaik you will need to pick one of the two options for focus (bug entry text area, or classification text area), because asking for both implies having focus in two places at the same time.
I'm asking for two new shortcuts: "pressing 'c' pins the current job if it isn't already, and focuses the classification textarea" "pressing 'r' pins the current job if it isn't already, adds a related bugs input, and focuses it" (along with the third, for finishing off both of them, "pressing ctrl+enter activates Save, no matter what has focus at the time")
Ok, thanks for the clarification Phil.
Sounds fine with me. At this point, Ctrl+Enter is probably what I find myself missing most.
Flags: needinfo?(ryanvm)
Sounds good to me, too.
Flags: needinfo?(kwierso)
I'm looking into the shortcut for related bugs input. Still some scope issues to be sorted.
Assignee: nobody → tojonmz
URL: http://treeherder.mozilla.org
Status: NEW → ASSIGNED
I sorted the scope issue mentioned above, in bug 1104149. For expediency and testing I'm going to deliver each of the requested shortcut features as separate PR's. I have the related bug shortcut done, PR coming up shortly.
Please see above PR for status and review.
Attachment #8529812 - Flags: review?(cdawson)
Phil, do you expect to save a classification via ctrl+enter if the job panel is open but the pinboard is not? Or only if the pinboard is also visible? I assume the latter, but want to check.
Flags: needinfo?(philringnalda)
The latter indeed, I can't imagine the former being anything other than a horrible accident in progress.
Flags: needinfo?(philringnalda)
Cool I'll let :camd review the first PR for related bug addition; and I'll need to rebase on that and then open the 2nd PR for the classification save. I have save working locally, and it appears to be fine.
Comment 19 sounds like the correct behavior to me, too.
Comment on attachment 8529812 [details] [review] treeherder-ui-relatedBugAddition-PR#281 Awesome. Thanks for fixing this. bummed I missed it... :/
Attachment #8529812 - Flags: review?(cdawson) → review+
Attachment #8529812 - Flags: review+ → review?(cdawson)
Commits pushed to master at https://github.com/mozilla/treeherder-ui https://github.com/mozilla/treeherder-ui/commit/74e1a1ab257ae8027c8128004b839702740ed9fb Bug 1030686 - Add keyboard shortcut for related bug addition https://github.com/mozilla/treeherder-ui/commit/cb41799562c6286799bfe0df5932aae61cd148f9 Merge pull request #281 from tojonmz/related-bug-shortcut Bug 1030686 - Add keyboard shortcut for related bug addition
Attachment #8529812 - Flags: review?(cdawson) → review+
Ok, I have part 3 (saving a classification) done, PR coming up.
Please see above PR for status and review.
Attachment #8531618 - Flags: review?(cdawson)
Commits pushed to master at https://github.com/mozilla/treeherder-ui https://github.com/mozilla/treeherder-ui/commit/0e5a2e0d8bd2d78f632de54cf354adcec2134de0 Bug 1030686 - Add keyboard shortcut for save job classification https://github.com/mozilla/treeherder-ui/commit/ec4c43cdacdcb0f75f1cc0451031f33c967e9f85 Merge pull request #286 from tojonmz/save-classification-shortcut Bug 1030686 - Add keyboard shortcut for save job classification
Part1 (classification entry/focus) will be up shortly.
There appears to be ambiguity with the current focusMe directive when you have more than one page element using its value. I don't believe we had needed this before. For example add related bug, and enter classification exist in the same partial. When the shortcut is invoked and focus is requested, the current directive applies focus to everything, seems to only find the "last" element for focus. So 'r' when pressed it wrongly focuses the classification field. If I've understood the issue correctly, there may be some directive work needed, to allow classification-entry to live happily alongside add-related-bug. I have a wip directive, I'll probably ping camd to try it out and see if I'm remotely on the right track :)
Attachment #8531618 - Flags: review?(cdawson) → review+
Unrelated, but I've verified Part2,3 (add related bug, save) on stage. Seems to be behaving as expected.
Please see above PR for status and review for the final task, 'part1' - adding the classification comment.
Attachment #8537622 - Flags: review?(cdawson)
Attachment #8537622 - Attachment description: treeherder-ui-PR#304 → treeherder-ui-commentAddition-PR#304
Commits pushed to master at https://github.com/mozilla/treeherder-ui https://github.com/mozilla/treeherder-ui/commit/fee5e3c482bab539ece9f80cb9abe04590571c3e Bug 1030686 - Add keyboard shortcut for classification entry https://github.com/mozilla/treeherder-ui/commit/a259dd60c19757d15e34ebd712d6ca01d08f90e1 Merge pull request #304 from tojonmz/enter-classification-shortcut Bug 1030686 - Add keyboard shortcut for classification entry
Attachment #8537622 - Flags: review?(cdawson) → review+
Marking Fixed based on the last merge, we now have all 3 shortcuts in master. I'll also mark verified once it's pushed to stage or prod.
Status: ASSIGNED → RESOLVED
Closed: 11 years ago
Resolution: --- → FIXED
Verified fixed and working correctly in production. We have one gecko specific issue in the Failure Summary panel which is exposed by the save shortcut, which is bug 1114665.
Status: RESOLVED → VERIFIED
Depends on: 1114839
Commits pushed to master at https://github.com/mozilla/treeherder https://github.com/mozilla/treeherder/commit/7bedd405785e06f45a44094adebbbdf63266faaa Bug 1030686 - Add keyboard shortcut for related bug addition https://github.com/mozilla/treeherder/commit/c9b2eb9c2d824a371e1a0a02576d2e4ccf4c0ce4 Merge pull request #281 from tojonmz/related-bug-shortcut Bug 1030686 - Add keyboard shortcut for related bug addition https://github.com/mozilla/treeherder/commit/60b54a977c08ae57cbac03489f04f7f8b669f459 Bug 1030686 - Add keyboard shortcut for save job classification https://github.com/mozilla/treeherder/commit/f6ad331c96f0f570a6bcc0423de6b992aff3b4f0 Merge pull request #286 from tojonmz/save-classification-shortcut Bug 1030686 - Add keyboard shortcut for save job classification https://github.com/mozilla/treeherder/commit/df5056e1c15ea962e1175edbb2a6e274bc3e0eb3 Bug 1030686 - Add keyboard shortcut for classification entry https://github.com/mozilla/treeherder/commit/addc23f774d9c86ba6be5d706e7f9835db24e045 Merge pull request #304 from tojonmz/enter-classification-shortcut Bug 1030686 - Add keyboard shortcut for classification entry
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: