Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh status: show status even if a comment 404s #7873

Merged
merged 4 commits into from
Sep 5, 2023
Merged

gh status: show status even if a comment 404s #7873

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
476ec83
gh status: show status even if a comment 404s
rwe Aug 20, 2023
1f9cf51
gh status: handle load errors via switch
rwe Aug 23, 2023
73a7745
gh status: omit notifications with missing comments
rwe Aug 31, 2023
f312613
Merge branch 'trunk' into fix-7872
rwe Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 23 additions & 9 deletions pkg/cmd/status/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,29 @@ func (s *StatusGetter) LoadNotifications() error {
if !ok {
return nil
}
if actual, err := s.ActualMention(n.Subject.LatestCommentURL); actual != "" && err == nil {
actual, err := s.ActualMention(n.Subject.LatestCommentURL)

if err != nil {
var httpErr api.HTTPError
httpStatusCode := -1

if errors.As(err, &httpErr) {
httpStatusCode = httpErr.StatusCode
}

switch httpStatusCode {
case 403:
s.addAuthError(httpErr.Message, factory.SSOURL())
return nil
case 404:
actual = "(could not fetch comment)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we actually want to display anything to the user in this case? They have no actions they can take to view the comment so this message does not provide a lot of value in my opinion. I would rather see us just skip to the next one and not display anything.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also waffled on that. Personally, I prefer seeing that a notification exists even if I can't see the text. The comment URL still shows up, which gives some context, e.g. indicating there's a comment a former client meant to be seen. (I suspect that they only exist for comments made before access was restricted, not new comments tagged privately…but I don't know). In that case, the action might be to reach out to the client and let them know they might need to fill you in directly.

🤷 But I also don't feel too strongly about it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the more common case of this occurring is that a comment was purposefully deleted for one reason or another and in that case showing nothing seems like the correct behavior.

For now lets go with not displaying anything and we can change the behavior in the future if we hear from users that they would rather have the other behavior.

default:
abortFetching()
return fmt.Errorf("could not fetch comment: %w", err)
}
}

if actual != "" {
// I'm so sorry
split := strings.Split(n.Subject.URL, "/")
fetched <- StatusItem{
Expand All @@ -295,14 +317,6 @@ func (s *StatusGetter) LoadNotifications() error {
preview: actual,
index: n.index,
}
} else if err != nil {
var httpErr api.HTTPError
if errors.As(err, &httpErr) && httpErr.StatusCode == 403 {
s.addAuthError(httpErr.Message, factory.SSOURL())
} else {
abortFetching()
return fmt.Errorf("could not fetch comment: %w", err)
}
}
}
}
Expand Down
57 changes: 57 additions & 0 deletions pkg/cmd/status/status_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,63 @@ func TestStatusRun(t *testing.T) {
warning: You don't have permission to access this resource.
`),
},
{
name: "not found errors",
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL("UserCurrent"),
httpmock.StringResponse(`{"data": {"viewer": {"login": "jillvalentine"}}}`))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I enjoy Resident Evil, too 🧟

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤷 Didn't catch the reference, actually! Just based on the surrounding stubs.

reg.Register(
httpmock.REST("GET", "repos/rpd/todo/issues/110"),
httpmock.StringResponse(`{"body":"hello @jillvalentine how are you"}`))
reg.Register(
httpmock.REST("GET", "repos/rpd/todo/issues/4113"),
httpmock.StringResponse(`{"body":"this is a comment"}`))
reg.Register(
httpmock.REST("GET", "repos/cli/cli/issues/1096"),
httpmock.StringResponse(`{"body":"@jillvalentine hi"}`))
reg.Register(
httpmock.REST("GET", "repos/rpd/todo/issues/comments/1065"),
httpmock.StatusStringResponse(404, `{
"message": "Not Found."
}`))
reg.Register(
httpmock.REST("GET", "repos/vilmibm/gh-screensaver/issues/comments/10"),
httpmock.StringResponse(`{"body":"a message for @jillvalentine"}`))
reg.Register(
httpmock.GraphQL("AssignedSearch"),
httpmock.FileResponse("./fixtures/search.json"))
reg.Register(
httpmock.REST("GET", "notifications"),
httpmock.FileResponse("./fixtures/notifications.json"))
reg.Register(
httpmock.REST("GET", "users/jillvalentine/received_events"),
httpmock.FileResponse("./fixtures/events.json"))
},
opts: &StatusOptions{},
wantOut: heredoc.Doc(`
Assigned Issues │ Assigned Pull Requests
vilmibm/testing#157 yolo │ cli/cli#5272 Pin extensions
cli/cli#3223 Repo garden...│ rpd/todo#73 Board up RPD windows
rpd/todo#514 Reducing zo...│ cli/cli#4768 Issue Frecency
vilmibm/testing#74 welp │
adreyer/arkestrator#22 complete mo...│
│
Review Requests │ Mentions
cli/cli#5272 Pin extensions │ rpd/todo#110 hello @j...
vilmibm/testing#1234 Foobar │ cli/cli#1096 @jillval...
rpd/todo#50 Welcome party...│ rpd/todo#116 (could n...
cli/cli#4671 This pull req...│ vilmibm/gh-screensaver#15 a messag...
rpd/todo#49 Haircut for Leon│
│
Repository Activity
rpd/todo#5326 new PR Only write UTF-8 BOM on W...
vilmibm/testing#5325 comment on Ability to sea... We are working on dedicat...
cli/cli#5319 comment on [Codespaces] D... Wondering if we shouldn't...
cli/cli#5300 new issue Terminal bell when a runn...

`),
},
{
name: "notification errors",
httpStubs: func(reg *httpmock.Registry) {
Expand Down