1181685 - Reconcile main UI element names and give them appropriate ID's for testing

Status: VERIFIED FIXED

(Tree Management :: Treeherder, defect, P3)

Description

[Jonathan French (:jfrench)]

So mozwebqa has kindly got a preliminary test running for Treeherder, and that process revealed that we should probably have some clearer names and consistent IDs for some of the main Treeherder UI rather than elements like 'bottom-left-bottom'. It should help test authoring, and perhaps general webdev recognition. For starters, I pose we have something like:

#details-panel* (the entire panel which opens when you click on a job... currently 'bottom-panel')
#pinboard-panel [unchanged]
#job-panel (currently 'bottom-panel-content', houses these items below...)

#job-details-panel (currently 'bottom-left-panel', houses these items...)
#job-details-actionbar (the left navbar section containing the 'Log' icon, etc)
#job-details-pane (currently 'bottom-left-bottom' containing our omnipresent info)

#job-tabs-panel (currently 'bottom-center-panel', houses these items...)
#job-tabs-navbar (currently 'bottom-center-top')
#job-tabs-pane (currently 'bottom-center-bottom')

* some other possibles for the main container:
edit-panel
info-panel
awesome-panel

...some of these we can also reference to users with equivalent names in a potential diagram in Help, calling out the various UI parts of Treeherder and what they do.

Comment 1

[Jonathan French (:jfrench)]

Soliciting a few folks for feedback on the proposed names above :)

Comment 2

[William Lachance (:wlach)]

This all sounds fine to me. For the main container, maybe resultset-panel makes sense? That's what it contains: resultsets.

Comment 3

[Jonathan French (:jfrench)]

Yup, that sounds good to me.

Comment 4

[Cameron Dawson [:camd]]

I like will's idea, too.  And the rest of the names sound great to me.  :)  We named these early on when we weren't totally sure what each of them would be used for, so position seemed logical at the time.  :)

Comment 5

[Jonathan French (:jfrench)]

Thank you, sounds like we're good to go. I can adjust further if required in my PR :)

Comment 6

[Rebecca Billings [:rbillings]]

This is great- and it'll definitely make testing and onboarding contributors easier.

Comment 7

[Jonathan French (:jfrench)]

(In reply to Jonathan French (:jfrench) from comment #0)
> * some other possibles for the main container:
> info-panel

I've actually opted for 'info-panel' for the entire lower panel unless anyone objects. It seems a bit more generalized and doesn't overuse the word 'details'; which is being used for its child, job-details.

Comment 8

[Jonathan French (:jfrench)]

Attachment: PR 740

Please see above PR for status and review.

Comment 9

[William Lachance (:wlach)]

Comment on attachment 8632142 [details] [review]
PR 740

Looks fine to me. Since this touches just about everything to do with the UI, should we do a quick run through the moztrap checklist before landing?

Comment 10

[Jonathan French (:jfrench)]

Sure, I did a bunch of testing as I added the changes, but I'll do a more formal moztrap run now.

Comment 11

[Jonathan French (:jfrench)]

https://moztrap.mozilla.org/runtests/run/7591/env/27938/

I think we're ok for deployment to stage, so I plan to rebase and merge.

Comment 12

[Treeherder GitHub Bugbot]

Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/1aeb17d182a3103b091289ccfa0f0498b5f68747
Bug 1181685 - Reconcile main UI element names/ids

Comment 13

[Jonathan French (:jfrench)]

Marking fixed per above merge. I'll verify on the next push to stage.

Comment 14

[Jonathan French (:jfrench)]

Verified fixed on both stage and production.