feat: add a "mark notification as done" button #706

adufr · 2024-01-18T08:14:41Z

Related issues

#500 - feature request: mark notifications as done

Context

Hi! This is my first PR on this repo; let me thank you for making this great app!

As a new user, I instantly found quite frustrating that I wasn't able to mark notifications as done. After doing some digging, I found that GitHub does now provide an endpoint for that 🎉

Discussion

This PR changes the existing "mark notification as read" icon, to better reflect what it does, and adds a new "mark notification as done" button right next to it:

Unfortunately, it looks like GitHub does not provide an endpoint for marking all notifications from a repository as done, so I couldn't add a new button to the Repository component 😞

Also, if that's OK with you I'd like to change the "Unsubscribe" button:

use the bell-slash icon to match GitHub's icon
change its positionning which feels odd in my opinion

Let me know what you think about it; I can do that in another PR if you prefer so 🤷

adufr · 2024-01-18T08:18:29Z

Also, on a side note, I have some other ideas for improvements that are now possible thanks to this new API endpoint:

add a setting to "mark as done" when clicking a notification (while still keeping the existing setting to "mark as read")
someway or another, add the posibility to not hide "read" notifications from Gitify (only hide "done" notifications)

LMK what you think about it, I'd gladly work on that too!

bmulholland · 2024-01-18T10:38:49Z

Your comments about read vs done are interesting. In my workflow, I generally treat "read" as "done." In your workflow, what's the difference between the two?

Edit: Actually, could you please split that discussion to a new Issue? That will keep this PR focused on a single topic (which already expands into discussions about positioning of icons etc).

bmulholland · 2024-01-18T10:42:13Z

Re: the changes here -- it seems natural to mirror the Github behaviour and icons. Looks like those don't have a read icon, actually. Opening the entry marks it as read. And I guess Done probably marks it as read + done? Maybe we could match that, which means only two icons. (This also means I support changing the icon to match Github's interface.)

If we do keep all three icons, then in a row as suggested at the bottom of the description looks best to me.

@afonsojramos What do you think?

bmulholland · 2024-01-18T10:42:52Z

BTW @adufr -- thanks for the contribution!

adufr · 2024-01-18T10:45:02Z

@bmulholland

Your comments about read vs done are interesting. In my workflow, I generally treat "read" as "done." In your workflow, what's the difference between the two?

Edit: Actually, could you please split that discussion to a new Issue? That will keep this PR focused on a single topic (which already expands into discussions about positioning of icons etc).

Yup I'll open 2 different issues, one for each matter

bmulholland · 2024-01-18T10:46:05Z

src/hooks/useNotifications.test.ts

+          expect(result.current.isFetching).toBe(false);
+        });
+
+        expect(result.current.notifications.length).toBe(0);


This seems odd. If the request failed, shouldn't the notification list remain untouched, length 1? My read of the code under test is that it doesn't change the notifications list in the failure condition, but maybe I'm wrong.

I agree, tbh I just copy pasted the markNotification tests, so they were already broken before my PR 😬

I'm trying to figure out how to initialize a non-empty notifications array with mocked data, but without any success for now...

setchy · 2024-01-18T13:47:19Z

Great contribution @adufr.

@bmulholland @adufr your comment above got me thinking....

Opening the entry marks it as read.

Does this mean that the setting Mark as read on click is no longer applicable, perhaps due to a change in GitHub's default behavior when opening an inbox notification?

bmulholland · 2024-01-18T14:00:24Z

Does this mean that the setting Mark as read on click is no longer applicable, perhaps due to a change in GitHub's default behavior when opening an inbox notification?

I've only recently picked up contributing here, so I'm not familiar with all the options. I wasn't considering that Setting. It does kinda feel like this read vs done workflow replaces the need for that. But I don't know what people actually use, and I suppose there's lots of possible workflows. We could take an opinionated approach to it but it would require deep consideration and that's beyond the level of effort I'm able to put in.

One easy take is this "mark as done" would replace the "mark as read," though. I honestly don't think most people know or care about the distinction, so having one button for mark as done, no button for mark as read, and keeping the setting seems like a reasonable middle ground.

setchy · 2024-01-18T14:40:42Z

From my observations, changing Mark as read on click has no change in behavior within GitHub anymore. From what I can tell, regardless of setting, it is always marked as read.

Is that the same experience you observe?

adufr · 2024-01-18T14:43:43Z

From my observations, changing Mark as read on click has no change in behavior within GitHub anymore. From what I can tell, regardless of setting, it is always marked as read.

Maybe Mark as read on click should be replaced with Mark as done on click then? 😅

But the Mark as read button could still be useful in the future; I'm going to open a feature request for a new setting that would allow to "Show read notifications" in Gitify (but hide "done" notifications)

EDIT: see #708 for the new feature request

bmulholland · 2024-01-19T12:18:29Z

Re: "Mark as read on click" -- I confirm this has no effect now, Github marks it as read when you open it anyway. We should remove the Setting.

Re: a "mark as done on click" -- When opening the notification, you get a blue bar at the top where you can click Done. That's two clicks, but it's also how Github does it, so maybe good enough?

adufr · 2024-01-19T12:36:35Z

Re: a "mark as done on click" -- When opening the notification, you get a blue bar at the top where you can click Done. That's two clicks, but it's also how Github does it, so maybe good enough?

Why not add the setting anyway? For those who, like me, might be happy to have it?

bmulholland · 2024-01-19T13:35:22Z

Why not add the setting anyway?

Sure, especially considering we just removed another setting :)

adufr · 2024-01-19T16:05:18Z

Me again -- do I need to change anything for this PR to be merged?

I'd like to work on other things (such as #714 or #708) that would require some shared functions, and I would prefer avoiding stacked PRs 😛

afonsojramos · 2024-01-19T17:54:02Z

Well, first of all great contribution @adufr! It sparked quite a lot of discussions so it is not even just about the individual contribution, thank you!

Sorry for coming late to the party, but these past days have been a bit hectic.

One easy take is this "mark as done" would replace the "mark as read," though. I honestly don't think most people know or care about the distinction, so having one button for mark as done, no button for mark as read, and keeping the setting seems like a reasonable middle ground.

Totally agree here! As now we've removed the "mark as read" I'd say that marking it as done on click would definitely be an option I would at least consider enabling to be honest. Everyone has a different workflow, so I'm up for it.

Unfortunately, it looks like GitHub does not provide an endpoint for marking all notifications from a repository as done, so I couldn't add a new button to the Repository component 😞

GitHub doesn't, but we probably could I believe... Seems like an easy add to just traverse across all of the repo notifications and mark them as done.

adufr · 2024-01-19T18:14:42Z

Thanks!

GitHub doesn't, but we probably could I believe... Seems like an easy add to just traverse across all of the repo notifications and mark them as done.

Yes I agree, I thought about it! but we should document ourselves about rate-limits just to be safe...

bmulholland · 2024-01-22T10:38:10Z

Okay, to keep us moving, how about we merge this PR, and agree on next steps (follow up PRs)? Are you cool with that @afonsojramos ? In that case, @adufr , only thing before merge is to get the branch green and conflict-free.

Those follow-on PRs are, I believe:

Make icons consistent with Github, as discussed, and fix their alignment (could be two PRs, for easier/faster review & merge)
Add option to "Mark as done on click"
Replace icon for "mark repo as read" with "mark repo as done." Optionally, deal with rate limits.

Have I missed anything?

adufr · 2024-01-30T17:56:03Z

Hi! Sorry I've been sick as hell for the past week!
I'm finally starting to feel better and so I'm more ready than ever to resume my work on Gitify!

So to clarify, IMO this PR is still valid as-is (I've just updated it with main)
Once this get's merged:

I'll open a PR for the icons consistency
I'll open another PR for the "Mark as done on click" setting

bmulholland · 2024-01-30T18:02:41Z

On my end, I'm good to merge this -- even if there's some details wrong, better to keep moving. Just one code thing: what about #706 (comment) ?

afonsojramos · 2024-01-31T03:25:32Z

Tests and build fail though. I'd prefer to have that fixed before merging.

adufr · 2024-01-31T08:33:46Z

Sorry it should be good now!

bmulholland · 2024-01-31T10:13:14Z

@afonsojramos I missed that, and I agree. Thanks!

bmulholland

LGTM. @afonsojramos good with you? Go ahead and merge if you're okay with it

afonsojramos

Looks good to me! Sorry for the late review!

adufr added 4 commits January 18, 2024 08:59

feat: add button to mark a notification as done

4f507d4

tests: add tests for markNotificationDone()

43e57e1

feat: update "mark notification as read" icon

a029946

tests: update snaps

8ad7e1e

adufr requested a review from bmulholland as a code owner January 18, 2024 08:14

bmulholland reviewed Jan 18, 2024

View reviewed changes

adufr mentioned this pull request Jan 18, 2024

Feature request: add a "Show read notifications" setting #708

Open

bmulholland mentioned this pull request Jan 19, 2024

Remove "Mark as read on click" Setting, which has no effect now #712

Closed

Merge branch 'gitify-app:main' into main

9671da8

Merge branch 'gitify-app:main' into main

eef30e8

adufr requested review from afonsojramos and setchy as code owners January 30, 2024 17:45

fix: remove now obsolete markOnClick

b4d9561

bmulholland approved these changes Jan 31, 2024

View reviewed changes

afonsojramos approved these changes Feb 6, 2024

View reviewed changes

afonsojramos merged commit 7c3523e into gitify-app:main Feb 6, 2024
7 checks passed

This was referenced Feb 6, 2024

feat: update/move "unsubscribe" icon #745

Merged

Feature Request : On Click, Mark as Done #500

Closed

This was referenced Feb 18, 2024

feat: add "Unsubscribe from repository" button #784

Closed

feat: mark repository as done #788

Merged

setchy added the enhancement New feature or enhancement to existing functionality label Mar 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add a "mark notification as done" button #706

feat: add a "mark notification as done" button #706

adufr commented Jan 18, 2024

adufr commented Jan 18, 2024

bmulholland commented Jan 18, 2024 •

edited

bmulholland commented Jan 18, 2024 •

edited

bmulholland commented Jan 18, 2024

adufr commented Jan 18, 2024

bmulholland Jan 18, 2024 •

edited

adufr Jan 18, 2024

setchy commented Jan 18, 2024

bmulholland commented Jan 18, 2024

setchy commented Jan 18, 2024 •

edited

adufr commented Jan 18, 2024 •

edited

bmulholland commented Jan 19, 2024

adufr commented Jan 19, 2024

bmulholland commented Jan 19, 2024

adufr commented Jan 19, 2024

afonsojramos commented Jan 19, 2024

adufr commented Jan 19, 2024

bmulholland commented Jan 22, 2024 •

edited

adufr commented Jan 30, 2024

bmulholland commented Jan 30, 2024

afonsojramos commented Jan 31, 2024

adufr commented Jan 31, 2024

bmulholland commented Jan 31, 2024

bmulholland left a comment

afonsojramos left a comment

feat: add a "mark notification as done" button #706

feat: add a "mark notification as done" button #706

Conversation

adufr commented Jan 18, 2024

Related issues

Context

Discussion

adufr commented Jan 18, 2024

bmulholland commented Jan 18, 2024 • edited

bmulholland commented Jan 18, 2024 • edited

bmulholland commented Jan 18, 2024

adufr commented Jan 18, 2024

bmulholland Jan 18, 2024 • edited

Choose a reason for hiding this comment

adufr Jan 18, 2024

Choose a reason for hiding this comment

setchy commented Jan 18, 2024

bmulholland commented Jan 18, 2024

setchy commented Jan 18, 2024 • edited

adufr commented Jan 18, 2024 • edited

bmulholland commented Jan 19, 2024

adufr commented Jan 19, 2024

bmulholland commented Jan 19, 2024

adufr commented Jan 19, 2024

afonsojramos commented Jan 19, 2024

adufr commented Jan 19, 2024

bmulholland commented Jan 22, 2024 • edited

adufr commented Jan 30, 2024

bmulholland commented Jan 30, 2024

afonsojramos commented Jan 31, 2024

adufr commented Jan 31, 2024

bmulholland commented Jan 31, 2024

bmulholland left a comment

Choose a reason for hiding this comment

afonsojramos left a comment

Choose a reason for hiding this comment

bmulholland commented Jan 18, 2024 •

edited

bmulholland commented Jan 18, 2024 •

edited

bmulholland Jan 18, 2024 •

edited

setchy commented Jan 18, 2024 •

edited

adufr commented Jan 18, 2024 •

edited

bmulholland commented Jan 22, 2024 •

edited