Additional entry point for review comments #2084

kuychaco · 2019-04-18T21:08:42Z

Please be sure to read the contributor's guide to the GitHub package before submitting any pull requests.

Requirements

Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
Suggestion: You can use checklists to keep track of progress for the sections on metrics, tests, documentation, and user research.

Description of the Change

We received feedback asking to save users clicks when looking at reviews for non-checked out branches. See #2077.

This PR enables users to access reviews for any PR listed in the GitHub tab (not just the checked out PR) via a "See reviews" context menu item.

I also took this opportunity to add a quick way to view the PR on dotcom via a "View on GitHub" context menu item.

Screenshot/Gif

Alternate Designs

Initially considered hiding the option behind a right-click context menu, but figured adding a kebab icon would make this more discoverable. The drawback is that the icon takes up some UI real-estate, but in my opinion it's small and discreet enough that it's fine. Open to feedback and other suggestions.

Benefits

Currently, it is only possible to view review comments for the checked out PR from the PR list.

In order to view review comments for a PR that is not checked out the user has to click the desired PR in the PR list to open the PR detail pane item, open the "Files" tab, and click the "See reviews" button in the footer of the tab.

With this change, we increase consistency by allowing the user to open reviews for any PR directly from the PR list. Previously this was only possible for the checked out PR.

Possible Drawbacks

None really... the only mild concern is that the additional icon might increase visual noise.

Applicable Issues

Fixes #2077

Metrics

Adding an event for 'open-reviews-tab'.
Adding an event for 'open-issueish-in-browser' to collect information about the users leaving the editor for the browser.

Tests

Tested openOnGitHub method along with open-issueish-in-browser event firing
Tested that showActionsMenu handler is called when the menu icon is clicked
Currently there is no good way to test Electron Menus.

Documentation

N/A

Release Notes

Access review comments for any PR listed in the GitHub panel via an "ellipses" icon

User Experience Research (Optional)

N/A

codecov · 2019-04-18T21:11:37Z

Codecov Report

Merging #2084 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #2084      +/-   ##
==========================================
+ Coverage   92.55%   92.55%   +<.01%     
==========================================
  Files         207      207              
  Lines       12016    12025       +9     
  Branches     1745     1747       +2     
==========================================
+ Hits        11121    11130       +9     
  Misses        895      895

Impacted Files	Coverage Δ
lib/containers/current-pull-request-container.js	`100% <ø> (ø)`	⬆️
lib/containers/issueish-search-container.js	`95.83% <ø> (ø)`	⬆️
lib/controllers/issueish-searches-controller.js	`73.68% <100%> (+7.01%)`	⬆️
lib/views/issueish-list-view.js	`97.5% <100%> (+0.35%)`	⬆️
lib/controllers/issueish-list-controller.js	`100% <100%> (ø)`	⬆️
lib/views/reviews-view.js	`82.5% <0%> (-0.22%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f98abf3...cff5a35. Read the comment docs.

aviflax · 2019-04-18T22:11:39Z

👋 I’m the user who shared the feedback in #2077. @annthurium pointed me to this PR and I think the change looks great!!!

…archesController

annthurium · 2019-04-19T14:53:06Z

styles/issueish-list-view.less

@@ -63,6 +63,11 @@
      text-align: center;
    }

+    &--menu {
+      color: @text-color-subtle;
+      transform: rotate(90deg);


@kuychaco : what's the rationale for rotating the icon?

I'm not a fan for a couple of reasons:

it's inconsistent with other kebab menus in the package such as undo discard which keep the icon in its original orientation.

right now the icon is not vertically centered. It's a lot more annoying to fix when the icon is rotated. If we remove the rotation we can just add a line-height of 1.

Sounds good! Thanks for making the change!

lib/controllers/issueish-list-controller.js

also remove rotation to be consistent with other kebab menus in the package

I staged the wrong file because I wasn't paying attention -- see previous commit.

Seems like there's no good way to test Electron menus. Not even supported in spectron -- electron-userland/spectron#21

Keep view simple and free of unnecessary logic

Co-Authored-By: Tilde Ann Thurium <annthurium@github.com>

vanessayuenn

I have some small nits with some of the tests, but otherwise this LGTM!

test/controllers/issueish-list-controller.test.js

Co-Authored-By: kuychaco <kuychaco@github.com>

Co-Authored-By: Vanessa Yuen <vanessayuenn@users.noreply.github.com>

kuychaco · 2019-04-29T19:26:48Z

That pending atom.github [old] check is irrelevant... it's an orphan left over from creating a new Azure pipeline to fix our Azure install. Gonna go ahead and merge this because we have all the green checks we need

kuychaco added 7 commits April 18, 2019 12:48

Add vertical ellipses for context menu

0679453

Lift logic for opening ReviewItem up to IssueishSearchesController

4bdaace

Pass down onOpenReviews callback as prop to IssueishListView

7cc3fab

Add menu with "See reviews" item

3e8a6c4

Make "See reviews" button call passed down prop

ec08555

🔥 unused openReviews in IssueishListController

7ee6f11

Add menu item for opening on GitHub

2aad757

kuychaco added the work-in-progress label Apr 18, 2019

kuychaco self-assigned this Apr 18, 2019

kuychaco added 3 commits April 18, 2019 17:16

Move test for opening review from IssuishListController to IssueishSe…

2944122

…archesController

Fix failing IsssueisListView test

7552148

👕

1aedec4

annthurium reviewed Apr 19, 2019

View reviewed changes

annthurium and others added 12 commits April 19, 2019 08:36

fix icon vertical centering

9afa981

also remove rotation to be consistent with other kebab menus in the package

actually fix the icon

c6a8138

I staged the wrong file because I wasn't paying attention -- see previous commit.

Istanbul ignore electron menu logic

5387610

Seems like there's no good way to test Electron menus. Not even supported in spectron -- electron-userland/spectron#21

Move logic to open issue on GitHub from view to controller

515f91c

Add open-issueish-in-browser event and pass url instead of issueish

2e47609

Move showActionsMenu to IssueishListController

65e95e3

Keep view simple and free of unnecessary logic

🔥 unnecessary imports

2432b84

Add prop types

d74436a

🔥 unused prop types

47312af

Test that showActionsMenu handler is called when octicon is clicked

005883e

Add test for openOnGitHub

7ea7c39

Add test for open-issueish-in-browser event

8d113d1

kuychaco removed the work-in-progress label Apr 23, 2019

kuychaco added 2 commits April 23, 2019 13:18

🔥 todo comment

9c5adda

Make click handler bound class method

0646872

kuychaco and others added 5 commits April 23, 2019 13:27

Oops, actually pass down showActionsMenu to the view

ea18395

Oops, showActionsMenu needs to be an arrow function to bind this

7f7565c

Fix parameters for showActionsMenu

f119527

Use istanbul ignore next correctly

dc25f9d

Co-Authored-By: Tilde Ann Thurium <annthurium@github.com>

Okay, _actually_ istanbul-ignore method this time

717f3e1

kuychaco marked this pull request as ready for review April 24, 2019 00:17

kuychaco requested a review from vanessayuenn April 24, 2019 22:54

vanessayuenn suggested changes Apr 25, 2019

View reviewed changes

vanessayuenn and others added 2 commits April 25, 2019 15:53

Update test/controllers/issueish-list-controller.test.js

ff20567

Co-Authored-By: kuychaco <kuychaco@github.com>

Use strictEqual instead of equal

62b2b89

Co-Authored-By: Vanessa Yuen <vanessayuenn@users.noreply.github.com>

kuychaco requested a review from vanessayuenn April 25, 2019 22:58

Empty commit to kick off CI after setup got messed up

cff5a35

kuychaco merged commit c28b7ef into master Apr 29, 2019

kuychaco deleted the ku-open-reviews-from-pr-list branch April 29, 2019 19:27

smashwilson added the feature request 003 Work related to the Pull Request Review feature request label May 3, 2019

smashwilson mentioned this pull request May 8, 2019

v0.29.0-0 QA Review #2129

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Additional entry point for review comments #2084

Additional entry point for review comments #2084

Uh oh!

kuychaco commented Apr 18, 2019 •

edited

Loading

Uh oh!

codecov bot commented Apr 18, 2019 •

edited

Loading

Uh oh!

aviflax commented Apr 18, 2019

Uh oh!

annthurium Apr 19, 2019

Uh oh!

kuychaco Apr 23, 2019

Uh oh!

Uh oh!

vanessayuenn left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuychaco commented Apr 29, 2019

Uh oh!

Uh oh!

Additional entry point for review comments #2084

Additional entry point for review comments #2084

Uh oh!

Conversation

kuychaco commented Apr 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Requirements

Description of the Change

Screenshot/Gif

Alternate Designs

Benefits

Possible Drawbacks

Applicable Issues

Metrics

Tests

Documentation

Release Notes

User Experience Research (Optional)

Uh oh!

codecov bot commented Apr 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aviflax commented Apr 18, 2019

Uh oh!

annthurium Apr 19, 2019

Choose a reason for hiding this comment

Uh oh!

kuychaco Apr 23, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vanessayuenn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuychaco commented Apr 29, 2019

Uh oh!

Uh oh!

kuychaco commented Apr 18, 2019 •

edited

Loading

codecov bot commented Apr 18, 2019 •

edited

Loading